[
https://issues.apache.org/jira/browse/HADOOP-17536?focusedWorklogId=583327&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-583327
]
ASF GitHub Bot logged work on HADOOP-17536:
-------------------------------------------
Author: ASF GitHub Bot
Created on: 15/Apr/21 11:31
Start Date: 15/Apr/21 11:31
Worklog Time Spent: 10m
Work Description: bilaharith commented on a change in pull request #2707:
URL: https://github.com/apache/hadoop/pull/2707#discussion_r613988562
##########
File path:
hadoop-tools/hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/ITestCustomerProvidedKey.java
##########
@@ -0,0 +1,937 @@
+/**
+ * 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.azurebfs;
+
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.nio.CharBuffer;
+import java.nio.charset.CharacterCodingException;
+import java.nio.charset.Charset;
+import java.nio.charset.CharsetEncoder;
+import java.nio.charset.StandardCharsets;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
+import java.util.EnumSet;
+import java.util.Hashtable;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Random;
+
+import org.apache.hadoop.fs.azurebfs.services.*;
+import org.assertj.core.api.Assertions;
+import org.junit.Assume;
+import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import org.apache.hadoop.fs.FSDataInputStream;
+import org.apache.hadoop.fs.FileStatus;
+import org.apache.hadoop.fs.XAttrSetFlag;
+import org.apache.hadoop.test.LambdaTestUtils;
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.fs.FSDataOutputStream;
+import org.apache.hadoop.fs.FileSystem;
+import org.apache.hadoop.fs.azurebfs.constants.HttpHeaderConfigurations;
+import org.apache.hadoop.fs.Path;
+import org.apache.hadoop.fs.azurebfs.constants.AbfsHttpConstants;
+import
org.apache.hadoop.fs.azurebfs.contracts.services.AppendRequestParameters;
+import
org.apache.hadoop.fs.azurebfs.contracts.services.AppendRequestParameters.Mode;
+import org.apache.hadoop.fs.azurebfs.utils.Base64;
+import org.apache.hadoop.fs.permission.AclEntry;
+import org.apache.hadoop.fs.permission.FsAction;
+import org.apache.hadoop.fs.permission.FsPermission;
+import org.apache.hadoop.thirdparty.com.google.common.base.Preconditions;
+import org.apache.hadoop.thirdparty.com.google.common.collect.Lists;
+
+import static
org.apache.hadoop.fs.azurebfs.constants.ConfigurationKeys.AZURE_CREATE_REMOTE_FILESYSTEM_DURING_INITIALIZATION;
+import static
org.apache.hadoop.fs.azurebfs.constants.ConfigurationKeys.FS_AZURE_CLIENT_PROVIDED_ENCRYPTION_KEY;
+import static
org.apache.hadoop.fs.azurebfs.constants.FileSystemConfigurations.ONE_MB;
+import static
org.apache.hadoop.fs.azurebfs.constants.HttpHeaderConfigurations.*;
+import static org.apache.hadoop.fs.azurebfs.constants.TestConfigurationKeys.*;
+import static org.apache.hadoop.fs.azurebfs.utils.AclTestHelpers.aclEntry;
+import static org.apache.hadoop.fs.permission.AclEntryScope.ACCESS;
+import static org.apache.hadoop.fs.permission.AclEntryType.USER;
+import static org.apache.hadoop.fs.permission.FsAction.ALL;
+
+public class ITestCustomerProvidedKey extends AbstractAbfsIntegrationTest {
+ private static final Logger LOG = LoggerFactory
+ .getLogger(ITestCustomerProvidedKey.class);
+
+ private static final String XMS_PROPERTIES_ENCODING = "ISO-8859-1";
+ private static final int INT_512 = 512;
+ private static final int INT_50 = 50;
+ private static final int ENCRYPTION_KEY_LEN = 32;
+ private static final int FILE_SIZE = 10 * ONE_MB;
+ private static final int FILE_SIZE_FOR_COPY_BETWEEN_ACCOUNTS = 24 * ONE_MB;
+
+ public ITestCustomerProvidedKey() throws Exception {
+ boolean isCPKTestsEnabled =
+ getConfiguration().getBoolean(FS_AZURE_TEST_CPK_ENABLED, false);
+ Assume.assumeTrue(isCPKTestsEnabled);
+ }
+
+ @Test
+ public void testReadWithCPK() throws Exception {
+ final AzureBlobFileSystem fs = getAbfs(true);
+ String fileName = "/" + methodName.getMethodName();
+ createFileAndGetContent(fs, fileName, FILE_SIZE);
+
+ AbfsClient abfsClient = fs.getAbfsClient();
+ int length = FILE_SIZE;
+ byte[] buffer = new byte[length];
+ final AbfsRestOperation op = abfsClient.getPathStatus(fileName, false);
+ final String eTag = op.getResult()
+ .getResponseHeader(HttpHeaderConfigurations.ETAG);
+ AbfsRestOperation abfsRestOperation = abfsClient
+ .read(fileName, 0, buffer, 0, length, eTag, null);
+ assertCPKHeaders(abfsRestOperation, true);
+ assertResponseHeader(abfsRestOperation, true, X_MS_ENCRYPTION_KEY_SHA256,
+ getCPKSha(fs));
+ assertResponseHeader(abfsRestOperation, true, X_MS_SERVER_ENCRYPTED,
+ "true");
+ assertResponseHeader(abfsRestOperation, false,
+ X_MS_REQUEST_SERVER_ENCRYPTED, "");
+
+ // Trying to read with different CPK headers
+ Configuration conf = fs.getConf();
+ String accountName = conf.get(FS_AZURE_ABFS_ACCOUNT_NAME);
+ conf.set(FS_AZURE_CLIENT_PROVIDED_ENCRYPTION_KEY + "." + accountName,
+ "different-1234567890123456789012");
+ conf.set("fs.abfs.impl.disable.cache", "true");
+ AzureBlobFileSystem fs2 = (AzureBlobFileSystem) FileSystem.get(conf);
+ try (FSDataInputStream iStream = fs2.open(new Path(fileName))) {
+ int len = 8 * ONE_MB;
+ byte[] b = new byte[len];
+ LambdaTestUtils.intercept(IOException.class, () -> {
+ iStream.read(b, 0, len);
+ });
+ }
+
+ // Trying to read with no CPK headers
+ conf.unset(FS_AZURE_CLIENT_PROVIDED_ENCRYPTION_KEY + "." + accountName);
+ AzureBlobFileSystem fs3 = (AzureBlobFileSystem) FileSystem.get(conf);
+ try (FSDataInputStream iStream = fs3.open(new Path(fileName))) {
+ int len = 8 * ONE_MB;
+ byte[] b = new byte[len];
+ LambdaTestUtils.intercept(IOException.class, () -> {
+ iStream.read(b, 0, len);
+ });
+ }
+ }
+
+ @Test
+ public void testReadWithoutCPK() throws Exception {
+ final AzureBlobFileSystem fs = getAbfs(false);
+ String fileName = "/" + methodName.getMethodName();
+ createFileAndGetContent(fs, fileName, FILE_SIZE);
+
+ AbfsClient abfsClient = fs.getAbfsClient();
+ int length = INT_512;
+ byte[] buffer = new byte[length * 4];
+ final AbfsRestOperation op = abfsClient.getPathStatus(fileName, false);
+ final String eTag = op.getResult()
+ .getResponseHeader(HttpHeaderConfigurations.ETAG);
+ AbfsRestOperation abfsRestOperation = abfsClient
+ .read(fileName, 0, buffer, 0, length, eTag, null);
+ assertCPKHeaders(abfsRestOperation, false);
+ assertResponseHeader(abfsRestOperation, false, X_MS_ENCRYPTION_KEY_SHA256,
+ getCPKSha(fs));
+ assertResponseHeader(abfsRestOperation, true, X_MS_SERVER_ENCRYPTED,
+ "true");
+ assertResponseHeader(abfsRestOperation, false,
+ X_MS_REQUEST_SERVER_ENCRYPTED, "");
+
+ // Trying to read with CPK headers
+ Configuration conf = fs.getConf();
+ String accountName = conf.get(FS_AZURE_ABFS_ACCOUNT_NAME);
+ conf.set(FS_AZURE_CLIENT_PROVIDED_ENCRYPTION_KEY + "." + accountName,
+ "12345678901234567890123456789012");
+ conf.set("fs.abfs.impl.disable.cache", "true");
+ AzureBlobFileSystem fs2 = (AzureBlobFileSystem) FileSystem.get(conf);
+ AbfsClient abfsClient2 = fs2.getAbfsClient();
+ LambdaTestUtils.intercept(IOException.class, () -> {
+ abfsClient2.read(fileName, 0, buffer, 0, length, eTag, null);
+ });
+ }
+
+ @Test
+ public void testAppendWithCPK() throws Exception {
+ final AzureBlobFileSystem fs = getAbfs(true);
+ final String fileName = "/" + methodName.getMethodName();
+ createFileAndGetContent(fs, fileName, FILE_SIZE);
+
+ // Trying to append with correct CPK headers
+ AppendRequestParameters appendRequestParameters =
+ new AppendRequestParameters(
+ 0, 0, 5, Mode.APPEND_MODE, false);
+ byte[] buffer = getRandomBytesArray(5);
+ AbfsClient abfsClient = fs.getAbfsClient();
+ AbfsRestOperation abfsRestOperation = abfsClient
+ .append(fileName, buffer, appendRequestParameters, null);
+ assertCPKHeaders(abfsRestOperation, true);
+ assertResponseHeader(abfsRestOperation, true, X_MS_ENCRYPTION_KEY_SHA256,
+ getCPKSha(fs));
+ assertResponseHeader(abfsRestOperation, false, X_MS_SERVER_ENCRYPTED, "");
+ assertResponseHeader(abfsRestOperation, true,
+ X_MS_REQUEST_SERVER_ENCRYPTED, "true");
+
+ // Trying to append with different CPK headers
+ Configuration conf = fs.getConf();
+ String accountName = conf.get(FS_AZURE_ABFS_ACCOUNT_NAME);
+ conf.set(FS_AZURE_CLIENT_PROVIDED_ENCRYPTION_KEY + "." + accountName,
+ "different-1234567890123456789012");
+ conf.set("fs.abfs.impl.disable.cache", "true");
+ AzureBlobFileSystem fs2 = (AzureBlobFileSystem) FileSystem.get(conf);
+ AbfsClient abfsClient2 = fs2.getAbfsClient();
+ LambdaTestUtils.intercept(IOException.class, () -> {
+ abfsClient2.append(fileName, buffer, appendRequestParameters, null);
+ });
+
+ // Trying to append with no CPK headers
+ conf.unset(FS_AZURE_CLIENT_PROVIDED_ENCRYPTION_KEY + "." + accountName);
+ AzureBlobFileSystem fs3 = (AzureBlobFileSystem) FileSystem.get(conf);
+ AbfsClient abfsClient3 = fs3.getAbfsClient();
+ LambdaTestUtils.intercept(IOException.class, () -> {
+ abfsClient3.append(fileName, buffer, appendRequestParameters, null);
+ });
+ }
+
+ @Test
+ public void testAppendWithoutCPK() throws Exception {
+ final AzureBlobFileSystem fs = getAbfs(false);
+ final String fileName = "/" + methodName.getMethodName();
+ createFileAndGetContent(fs, fileName, FILE_SIZE);
+
+ // Trying to append without CPK headers
+ AppendRequestParameters appendRequestParameters =
+ new AppendRequestParameters(
+ 0, 0, 5, Mode.APPEND_MODE, false);
+ byte[] buffer = getRandomBytesArray(5);
+ AbfsClient abfsClient = fs.getAbfsClient();
+ AbfsRestOperation abfsRestOperation = abfsClient
+ .append(fileName, buffer, appendRequestParameters, null);
+ assertCPKHeaders(abfsRestOperation, false);
+ assertResponseHeader(abfsRestOperation, false, X_MS_ENCRYPTION_KEY_SHA256,
+ "");
+ assertResponseHeader(abfsRestOperation, false, X_MS_SERVER_ENCRYPTED, "");
+ assertResponseHeader(abfsRestOperation, true,
+ X_MS_REQUEST_SERVER_ENCRYPTED, "true");
+
+ // Trying to append with CPK headers
+ Configuration conf = fs.getConf();
+ String accountName = conf.get(FS_AZURE_ABFS_ACCOUNT_NAME);
+ conf.set(FS_AZURE_CLIENT_PROVIDED_ENCRYPTION_KEY + "." + accountName,
+ "12345678901234567890123456789012");
+ conf.set("fs.abfs.impl.disable.cache", "true");
+ AzureBlobFileSystem fs2 = (AzureBlobFileSystem) FileSystem.get(conf);
+ AbfsClient abfsClient2 = fs2.getAbfsClient();
+ LambdaTestUtils.intercept(IOException.class, () -> {
+ abfsClient2.append(fileName, buffer, appendRequestParameters, null);
+ });
+ }
+
+ @Test
+ public void testSetGetXAttr() throws Exception {
+ final AzureBlobFileSystem fs = getAbfs(true);
+ String fileName = methodName.getMethodName();
+ createFileAndGetContent(fs, fileName, FILE_SIZE);
+
+ String valSent = "testValue";
+ String attrName = "testXAttr";
+
+ // set get and verify
+ fs.setXAttr(new Path(fileName), attrName,
+ valSent.getBytes(StandardCharsets.UTF_8),
+ EnumSet.of(XAttrSetFlag.CREATE));
+ byte[] valBytes = fs.getXAttr(new Path(fileName), attrName);
+ String valRecieved = new String(valBytes);
+ assertEquals(valSent, valRecieved);
+
+ // set new value get and verify
+ valSent = "new value";
+ fs.setXAttr(new Path(fileName), attrName,
+ valSent.getBytes(StandardCharsets.UTF_8),
+ EnumSet.of(XAttrSetFlag.REPLACE));
+ valBytes = fs.getXAttr(new Path(fileName), attrName);
+ valRecieved = new String(valBytes);
+ assertEquals(valSent, valRecieved);
+
+ // Read without CPK header
+ LambdaTestUtils.intercept(IOException.class, () -> {
+ getAbfs(false).getXAttr(new Path(fileName), attrName);
+ });
+
+ // Wrong CPK
+ LambdaTestUtils.intercept(IOException.class, () -> {
+ getSameFSWithWrongCPK(fs).getXAttr(new Path(fileName), attrName);
+ });
+ }
+
+ @Test
+ public void testCopyBetweenAccounts() throws Exception {
+ String accountName = getRawConfiguration()
+ .get(FS_AZURE_TEST_CPK_ENABLED_SECONDARY_ACCOUNT);
+ String accountKey = getRawConfiguration()
+ .get(FS_AZURE_TEST_CPK_ENABLED_SECONDARY_ACCOUNT_KEY);
+ Assume.assumeTrue(accountName != null && !accountName.isEmpty());
+ Assume.assumeTrue(accountKey != null && !accountKey.isEmpty());
+ String fileSystemName = "cpkfs";
+
+ // Create fs1 and a file with CPK
+ AzureBlobFileSystem fs1 = getAbfs(true);
+ int fileSize = FILE_SIZE_FOR_COPY_BETWEEN_ACCOUNTS;
+ byte[] fileContent = getRandomBytesArray(fileSize);
+ Path testFilePath = createFileWithContent(fs1, "fs1-file.txt",
fileContent);
+
+ // Create fs2 with different CPK
+ Configuration conf = new Configuration();
+ conf.set("fs.abfs.impl.disable.cache", "true");
+ conf.addResource(TEST_CONFIGURATION_FILE_NAME);
+ conf.setBoolean(AZURE_CREATE_REMOTE_FILESYSTEM_DURING_INITIALIZATION,
true);
+ conf.unset(FS_AZURE_ABFS_ACCOUNT_NAME);
+ conf.set(FS_AZURE_ABFS_ACCOUNT_NAME, accountName);
+ conf.set(FS_AZURE_ACCOUNT_KEY + "." + accountName, accountKey);
+ conf.set(FS_AZURE_CLIENT_PROVIDED_ENCRYPTION_KEY + "." + accountName,
+ "123456789012345678901234567890ab");
+ conf.set("fs.defaultFS", "abfs://" + fileSystemName + "@" + accountName);
+ AzureBlobFileSystem fs2 = (AzureBlobFileSystem) FileSystem.get(conf);
+
+ // Read from fs1 and write to fs2, fs1 and fs2 are having different CPK
+ Path fs2DestFilePath = new Path("fs2-dest-file.txt");
+ FSDataOutputStream ops = fs2.create(fs2DestFilePath);
Review comment:
Done
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 583327)
Time Spent: 11h (was: 10h 50m)
> ABFS: Suport for customer provided encrption key
> ------------------------------------------------
>
> Key: HADOOP-17536
> URL: https://issues.apache.org/jira/browse/HADOOP-17536
> Project: Hadoop Common
> Issue Type: Sub-task
> Components: fs/azure
> Affects Versions: 3.4.0
> Reporter: Bilahari T H
> Assignee: Bilahari T H
> Priority: Minor
> Labels: pull-request-available
> Time Spent: 11h
> Remaining Estimate: 0h
>
> The data for a particular customer needs to be encrypted on account level. At
> server side the APIs will start accepting the encryption key as part of
> request headers. The data will be encrypted/decrypted with the given key at
> the server.
> Since the ABFS FileSystem APIs are implementations for Hadoop FileSystem APIs
> there is no direct way with which customer can pass the key to ABFS driver.
> In this case driver should have the following capabilities so that it can
> accept and pass the encryption key as one of the request headers.
> # There should be a way to configure the encryption key for different
> accounts.
> # If there is a key specified for a particular account, the same needs to be
> sent along with the request headers.
> *Config changes*
> They key for an account can be specified in the core-site as follows.
> fs.azure.account.client-provided-encryption-key.{account
> name}.dfs.core.windows.net
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
