HADOOP-18850 Enable dual-layer server-side encryption with AWS KMS keys #6140
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
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,167 @@ | ||
| /* | ||
| * 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.hadoop.fs.s3a; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| import org.junit.Ignore; | ||
| import org.junit.Test; | ||
|
|
||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.apache.hadoop.conf.Configuration; | ||
| import org.apache.hadoop.fs.FileSystem; | ||
| import org.apache.hadoop.fs.Path; | ||
| import org.apache.hadoop.fs.contract.ContractTestUtils; | ||
| import org.apache.hadoop.fs.s3a.auth.delegation.EncryptionSecrets; | ||
|
|
||
| import static org.apache.hadoop.fs.contract.ContractTestUtils.dataset; | ||
| import static org.apache.hadoop.fs.contract.ContractTestUtils.skip; | ||
| import static org.apache.hadoop.fs.contract.ContractTestUtils.writeDataset; | ||
| import static org.apache.hadoop.fs.s3a.Constants.S3_ENCRYPTION_ALGORITHM; | ||
| import static org.apache.hadoop.fs.s3a.Constants.SERVER_SIDE_ENCRYPTION_ALGORITHM; | ||
| import static org.apache.hadoop.fs.s3a.EncryptionTestUtils.AWS_KMS_DSSE_ALGORITHM; | ||
| import static org.apache.hadoop.fs.s3a.S3AEncryptionMethods.DSSE_KMS; | ||
| import static org.apache.hadoop.fs.s3a.S3ATestUtils.getTestBucketName; | ||
| import static org.apache.hadoop.fs.s3a.S3ATestUtils.removeBaseAndBucketOverrides; | ||
| import static org.apache.hadoop.fs.s3a.S3ATestUtils.skipIfEncryptionNotSet; | ||
| import static org.apache.hadoop.fs.s3a.S3AUtils.getS3EncryptionKey; | ||
|
|
||
| /** | ||
| * Concrete class that extends {@link AbstractTestS3AEncryption} | ||
| * and tests already configured bucket level DSSE encryption using s3 console. | ||
| */ | ||
| public class ITestS3ADSSEEncryptionWithDefaultS3Settings extends | ||
| AbstractTestS3AEncryption { | ||
|
|
||
| @Override | ||
| public void setup() throws Exception { | ||
| super.setup(); | ||
| // get the KMS key for this test. | ||
| S3AFileSystem fs = getFileSystem(); | ||
| Configuration c = fs.getConf(); | ||
| skipIfEncryptionNotSet(c, getSSEAlgorithm()); | ||
| } | ||
|
|
||
| @SuppressWarnings("deprecation") | ||
| @Override | ||
| protected void patchConfigurationEncryptionSettings( | ||
| final Configuration conf) { | ||
| removeBaseAndBucketOverrides(conf, | ||
| S3_ENCRYPTION_ALGORITHM, | ||
| SERVER_SIDE_ENCRYPTION_ALGORITHM); | ||
| conf.set(S3_ENCRYPTION_ALGORITHM, | ||
| getSSEAlgorithm().getMethod()); | ||
| } | ||
|
|
||
| /** | ||
| * Setting this to NONE as we don't want to overwrite | ||
| * already configured encryption settings. | ||
| * @return the algorithm | ||
| */ | ||
| @Override | ||
| protected S3AEncryptionMethods getSSEAlgorithm() { | ||
| return S3AEncryptionMethods.NONE; | ||
| } | ||
|
|
||
| /** | ||
| * The check here is that the object is encrypted | ||
| * <i>and</i> that the encryption key is the KMS key | ||
| * provided, not any default key. | ||
| * @param path path | ||
| */ | ||
| @Override | ||
| protected void assertEncrypted(Path path) throws IOException { | ||
| S3AFileSystem fs = getFileSystem(); | ||
| Configuration c = fs.getConf(); | ||
| String kmsKey = getS3EncryptionKey(getTestBucketName(c), c); | ||
| EncryptionTestUtils.assertEncrypted(fs, path, DSSE_KMS, kmsKey); | ||
| } | ||
|
|
||
| @Override | ||
| @Ignore | ||
| @Test | ||
| public void testEncryptionSettingPropagation() throws Throwable { | ||
| } | ||
|
|
||
| @Override | ||
| @Ignore | ||
| @Test | ||
| public void testEncryption() throws Throwable { | ||
| } | ||
|
|
||
| /** | ||
| * Skipping if the test bucket is not configured with | ||
| * aws:kms encryption algorithm. | ||
| */ | ||
| @Override | ||
| public void testEncryptionOverRename() throws Throwable { | ||
| skipIfBucketNotKmsEncrypted(); | ||
| super.testEncryptionOverRename(); | ||
| } | ||
|
|
||
| /** | ||
| * If the test bucket is not configured with aws:kms encryption algorithm, | ||
| * skip the test. | ||
| * | ||
| * @throws IOException If the object creation/deletion/access fails. | ||
| */ | ||
| private void skipIfBucketNotKmsEncrypted() throws IOException { | ||
| S3AFileSystem fs = getFileSystem(); | ||
| Path path = path(getMethodName() + "find-encryption-algo"); | ||
|
||
| ContractTestUtils.touch(fs, path); | ||
| try { | ||
| String sseAlgorithm = | ||
| getS3AInternals().getObjectMetadata(path).serverSideEncryptionAsString(); | ||
| if (StringUtils.isBlank(sseAlgorithm) || !sseAlgorithm.equals(AWS_KMS_DSSE_ALGORITHM)) { | ||
| skip("Test bucket is not configured with " + AWS_KMS_DSSE_ALGORITHM); | ||
| } | ||
| } finally { | ||
| ContractTestUtils.assertDeleted(fs, path, false); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testEncryptionOverRename2() throws Throwable { | ||
| skipIfBucketNotKmsEncrypted(); | ||
| S3AFileSystem fs = getFileSystem(); | ||
|
|
||
| // write the file with the unencrypted FS. | ||
| // this will pick up whatever defaults we have. | ||
| Path src = path(createFilename(1024)); | ||
| byte[] data = dataset(1024, 'a', 'z'); | ||
| EncryptionSecrets secrets = fs.getEncryptionSecrets(); | ||
| validateEncryptionSecrets(secrets); | ||
| writeDataset(fs, src, data, data.length, 1024 * 1024, true); | ||
| ContractTestUtils.verifyFileContents(fs, src, data); | ||
|
|
||
| Configuration fs2Conf = new Configuration(fs.getConf()); | ||
| fs2Conf.set(S3_ENCRYPTION_ALGORITHM, | ||
| DSSE_KMS.getMethod()); | ||
| try (FileSystem kmsFS = FileSystem.newInstance(fs.getUri(), fs2Conf)) { | ||
| Path targetDir = path("target"); | ||
| kmsFS.mkdirs(targetDir); | ||
| ContractTestUtils.rename(kmsFS, src, targetDir); | ||
| Path renamedFile = new Path(targetDir, src.getName()); | ||
| ContractTestUtils.verifyFileContents(fs, renamedFile, data); | ||
| String kmsKey = getS3EncryptionKey(getTestBucketName(fs2Conf), fs2Conf); | ||
| // we assert that the renamed file has picked up the KMS key of our FS | ||
| EncryptionTestUtils.assertEncrypted(fs, renamedFile, DSSE_KMS, kmsKey); | ||
| } | ||
| } | ||
| } | ||
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,55 @@ | ||
| /** | ||
| * 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 | ||
| * <p> | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * <p> | ||
| * 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.hadoop.fs.s3a; | ||
|
|
||
| import org.apache.commons.lang.StringUtils; | ||
| import org.apache.hadoop.conf.Configuration; | ||
|
|
||
| import static org.apache.hadoop.fs.contract.ContractTestUtils.skip; | ||
| import static org.apache.hadoop.fs.s3a.Constants.S3_ENCRYPTION_KEY; | ||
| import static org.apache.hadoop.fs.s3a.S3AEncryptionMethods.DSSE_KMS; | ||
| import static org.apache.hadoop.fs.s3a.S3ATestUtils.getTestBucketName; | ||
|
|
||
| /** | ||
| * Concrete class that extends {@link AbstractTestS3AEncryption} | ||
| * and tests DSSE-KMS encryption. | ||
| */ | ||
| public class ITestS3AEncryptionDSSEKMSUserDefinedKey | ||
| extends AbstractTestS3AEncryption { | ||
|
|
||
| @Override | ||
| protected Configuration createConfiguration() { | ||
| // get the KMS key for this test. | ||
| Configuration c = new Configuration(); | ||
| String kmsKey = S3AUtils.getS3EncryptionKey(getTestBucketName(c), c); | ||
| // skip the test if DSSE-KMS or KMS key not set. | ||
| if (StringUtils.isBlank(kmsKey)) { | ||
| skip(S3_ENCRYPTION_KEY + " is not set for " + | ||
|
||
| DSSE_KMS.getMethod()); | ||
| } | ||
| Configuration conf = super.createConfiguration(); | ||
| conf.set(S3_ENCRYPTION_KEY, kmsKey); | ||
| return conf; | ||
| } | ||
|
|
||
| @Override | ||
| protected S3AEncryptionMethods getSSEAlgorithm() { | ||
| return DSSE_KMS; | ||
| } | ||
| } | ||
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
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.
how about we move to a switch() here and add a default for unknown stuff