gschaer commented on a change in pull request #5078: URL: https://github.com/apache/nifi/pull/5078#discussion_r659369630
########## File path: nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/storage/utils/AzureBlobClientSideEncryptionUtils.java ########## @@ -0,0 +1,116 @@ +/* + * 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.nifi.processors.azure.storage.utils; + +import com.google.common.base.Strings; +import com.microsoft.azure.keyvault.cryptography.SymmetricKey; +import org.apache.commons.codec.DecoderException; +import org.apache.commons.codec.binary.Hex; +import org.apache.nifi.components.AllowableValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.ValidationContext; +import org.apache.nifi.components.ValidationResult; +import org.apache.nifi.expression.ExpressionLanguageScope; +import org.apache.nifi.processor.util.StandardValidators; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; + +public class AzureBlobClientSideEncryptionUtils { + public static final PropertyDescriptor CSE_KEY_TYPE = new PropertyDescriptor.Builder() + .name("cse-key-type") + .displayName("Client-Side Encryption key type") + .required(true) + .allowableValues(buildCseEncryptionMethodAllowableValues()) + .defaultValue(AzureBlobClientSideEncryptionMethod.NONE.name()) + .description("Specifies the key type to use for client-side encryption.") + .build(); + + public static final PropertyDescriptor CSE_KEY_ID = new PropertyDescriptor.Builder() + .name("cse-key-id") + .displayName("Client-Side Encryption key ID") + .description("Specifies the ID of the key to use for client-side encryption.") + .expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES) + .required(false) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor CSE_SYMMETRIC_KEY_HEX = new PropertyDescriptor.Builder() + .name("cse-symmetric-key-hex") + .displayName("Symmetric Key (hexadecimal)") + .description("When using symmetric client-side encryption, this is the raw key, encoded in hexadecimal") + .required(false) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .sensitive(true) + .build(); + + private static AllowableValue[] buildCseEncryptionMethodAllowableValues() { + final AzureBlobClientSideEncryptionMethod[] encryptionMethods = AzureBlobClientSideEncryptionMethod.values(); + List<AllowableValue> allowableValues = new ArrayList<>(encryptionMethods.length); + for (AzureBlobClientSideEncryptionMethod em : encryptionMethods) { + allowableValues.add(new AllowableValue(em.name(), em.name(), em.toString())); + } + + return allowableValues.toArray(new AllowableValue[0]); + } + + public static Collection<ValidationResult> validateClientSideEncryptionProperties(ValidationContext validationContext) { + final List<ValidationResult> validationResults = new ArrayList<>(); + + final String cseKeyTypeValue = validationContext.getProperty(CSE_KEY_TYPE).getValue(); + final AzureBlobClientSideEncryptionMethod cseKeyType = AzureBlobClientSideEncryptionMethod.valueOf(cseKeyTypeValue); + + final String cseKeyId = validationContext.getProperty(CSE_KEY_ID).getValue(); + + final String cseSymmetricKeyHex = validationContext.getProperty(CSE_SYMMETRIC_KEY_HEX).getValue(); + + if (cseKeyType != AzureBlobClientSideEncryptionMethod.NONE && Strings.isNullOrEmpty(cseKeyId)) { + validationResults.add(new ValidationResult.Builder().subject(CSE_KEY_ID.getDisplayName()) + .explanation("a key ID must be set when client-side encryption is enabled.").build()); + } + + if (cseKeyType == AzureBlobClientSideEncryptionMethod.SYMMETRIC) { + validationResults.addAll(validateSymmetricKey(cseSymmetricKeyHex)); + } + + return validationResults; + } + + private static List<ValidationResult> validateSymmetricKey(String keyHex) { + List<ValidationResult> validationResults = new ArrayList<>(); + if (Strings.isNullOrEmpty(keyHex)) { + validationResults.add(new ValidationResult.Builder().subject(CSE_SYMMETRIC_KEY_HEX.getDisplayName()) + .explanation("a symmetric key must not be set when client-side encryption is enabled with symmetric encryption.").build()); + } else { + byte[] keyBytes; + try { + keyBytes = Hex.decodeHex(keyHex.toCharArray()); + new SymmetricKey("nifi", keyBytes); + } catch (DecoderException e) { + validationResults.add(new ValidationResult.Builder().subject(CSE_SYMMETRIC_KEY_HEX.getDisplayName()) + .explanation("the symmetric key must be valid hexadecimal string.").build()); Review comment: Fixed in b15cfdc ########## File path: nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/storage/utils/AzureBlobClientSideEncryptionUtils.java ########## @@ -0,0 +1,116 @@ +/* + * 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.nifi.processors.azure.storage.utils; + +import com.google.common.base.Strings; +import com.microsoft.azure.keyvault.cryptography.SymmetricKey; +import org.apache.commons.codec.DecoderException; +import org.apache.commons.codec.binary.Hex; +import org.apache.nifi.components.AllowableValue; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.ValidationContext; +import org.apache.nifi.components.ValidationResult; +import org.apache.nifi.expression.ExpressionLanguageScope; +import org.apache.nifi.processor.util.StandardValidators; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; + +public class AzureBlobClientSideEncryptionUtils { + public static final PropertyDescriptor CSE_KEY_TYPE = new PropertyDescriptor.Builder() + .name("cse-key-type") + .displayName("Client-Side Encryption key type") + .required(true) + .allowableValues(buildCseEncryptionMethodAllowableValues()) + .defaultValue(AzureBlobClientSideEncryptionMethod.NONE.name()) + .description("Specifies the key type to use for client-side encryption.") + .build(); + + public static final PropertyDescriptor CSE_KEY_ID = new PropertyDescriptor.Builder() + .name("cse-key-id") + .displayName("Client-Side Encryption key ID") + .description("Specifies the ID of the key to use for client-side encryption.") + .expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES) + .required(false) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .build(); + + public static final PropertyDescriptor CSE_SYMMETRIC_KEY_HEX = new PropertyDescriptor.Builder() + .name("cse-symmetric-key-hex") + .displayName("Symmetric Key (hexadecimal)") + .description("When using symmetric client-side encryption, this is the raw key, encoded in hexadecimal") + .required(false) + .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) + .sensitive(true) + .build(); + + private static AllowableValue[] buildCseEncryptionMethodAllowableValues() { + final AzureBlobClientSideEncryptionMethod[] encryptionMethods = AzureBlobClientSideEncryptionMethod.values(); + List<AllowableValue> allowableValues = new ArrayList<>(encryptionMethods.length); + for (AzureBlobClientSideEncryptionMethod em : encryptionMethods) { + allowableValues.add(new AllowableValue(em.name(), em.name(), em.toString())); + } + + return allowableValues.toArray(new AllowableValue[0]); + } + + public static Collection<ValidationResult> validateClientSideEncryptionProperties(ValidationContext validationContext) { + final List<ValidationResult> validationResults = new ArrayList<>(); + + final String cseKeyTypeValue = validationContext.getProperty(CSE_KEY_TYPE).getValue(); + final AzureBlobClientSideEncryptionMethod cseKeyType = AzureBlobClientSideEncryptionMethod.valueOf(cseKeyTypeValue); + + final String cseKeyId = validationContext.getProperty(CSE_KEY_ID).getValue(); + + final String cseSymmetricKeyHex = validationContext.getProperty(CSE_SYMMETRIC_KEY_HEX).getValue(); + + if (cseKeyType != AzureBlobClientSideEncryptionMethod.NONE && Strings.isNullOrEmpty(cseKeyId)) { + validationResults.add(new ValidationResult.Builder().subject(CSE_KEY_ID.getDisplayName()) + .explanation("a key ID must be set when client-side encryption is enabled.").build()); + } + + if (cseKeyType == AzureBlobClientSideEncryptionMethod.SYMMETRIC) { + validationResults.addAll(validateSymmetricKey(cseSymmetricKeyHex)); + } + + return validationResults; + } + + private static List<ValidationResult> validateSymmetricKey(String keyHex) { + List<ValidationResult> validationResults = new ArrayList<>(); + if (Strings.isNullOrEmpty(keyHex)) { + validationResults.add(new ValidationResult.Builder().subject(CSE_SYMMETRIC_KEY_HEX.getDisplayName()) + .explanation("a symmetric key must not be set when client-side encryption is enabled with symmetric encryption.").build()); + } else { + byte[] keyBytes; + try { + keyBytes = Hex.decodeHex(keyHex.toCharArray()); + new SymmetricKey("nifi", keyBytes); Review comment: Fixed in b15cfdc -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
