exceptionfactory commented on a change in pull request #5202: URL: https://github.com/apache/nifi/pull/5202#discussion_r674339432
########## File path: nifi-commons/nifi-sensitive-property-provider/src/main/java/org/apache/nifi/properties/AWSSensitivePropertyProvider.java ########## @@ -0,0 +1,336 @@ +/* + * 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.properties; + +import org.apache.commons.lang3.StringUtils; +import org.apache.nifi.properties.BootstrapProperties.BootstrapPropertyKey; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import software.amazon.awssdk.auth.credentials.AwsBasicCredentials; +import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider; +import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider; +import software.amazon.awssdk.core.SdkBytes; +import software.amazon.awssdk.core.exception.SdkClientException; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.kms.KmsClient; +import software.amazon.awssdk.services.kms.model.DecryptRequest; +import software.amazon.awssdk.services.kms.model.DecryptResponse; +import software.amazon.awssdk.services.kms.model.DescribeKeyRequest; +import software.amazon.awssdk.services.kms.model.DescribeKeyResponse; +import software.amazon.awssdk.services.kms.model.EncryptRequest; +import software.amazon.awssdk.services.kms.model.EncryptResponse; +import software.amazon.awssdk.services.kms.model.KeyMetadata; +import software.amazon.awssdk.services.kms.model.KmsException; + +import java.util.Base64; +import java.io.IOException; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.nio.file.Paths; +import java.util.Objects; + +public class AWSSensitivePropertyProvider extends AbstractSensitivePropertyProvider { + private static final Logger logger = LoggerFactory.getLogger(AWSSensitivePropertyProvider.class); + + private static final String AWS_PREFIX = "aws"; + private static final String ACCESS_KEY_PROPS_NAME = "aws.access.key.id"; + private static final String SECRET_KEY_PROPS_NAME = "aws.secret.key.id"; Review comment: Recommend changing this property name to `aws.secret.key`: ```suggestion private static final String SECRET_KEY_PROPS_NAME = "aws.secret.key"; ``` ########## File path: nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/conf/bootstrap-aws.conf ########## @@ -0,0 +1,28 @@ +# +# 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. +# + +# AWS KMS Key ID is required to be configured for AWS KMS Sensitive Property Provider +aws.kms.key.id= + +# First attempts to use credentials/configuration in bootstrap-aws.conf. +# If credentials/configuration in bootstrap-aws.conf is not fully configured, +# attempt to initialize credentials using default AWS credentials/configuration chain. + +# Optional AWS KMS Client Configuration/Credentials (all of them must be set in order to be used) +aws.access.key.id= +aws.secret.key.id= Review comment: ```suggestion aws.secret.key= ``` ########## File path: nifi-docs/src/main/asciidoc/toolkit-guide.adoc ########## @@ -504,6 +504,26 @@ This protection scheme uses HashiCorp Vault's Transit Secrets Engine (https://ww |`vault.ssl.trust-store-password`|Truststore password. Required if the Vault server is TLS-enabled|_none_ |=== +==== AWS_KMS +This protection scheme uses AWS Key Management Service (https://aws.amazon.com/kms/) for encryption and decryption. AWS KMS configuration properties can be stored in the `bootstrap-aws.conf` file, as referenced in the `bootstrap.conf` of NiFi or NiFi Registry. If the configuration properties are not specified in `bootstrap-aws.conf`, then the provider will attempt to use the AWS default credentials provider, which checks standard environment variables and system properties. + +===== Required properties +[options="header,footer"] +|=== +|Property Name|Description|Default +|`aws.kms.key.id`|The identifier or ARN that the AWS KMS client uses for encryption and decryption.|_none_ +|=== + +===== Optional properties +====== All of the following must be configured, or will be ignored entirely. +[options="header,footer"] +|=== +|Property Name|Description|Default +|`aws.region`|The AWS region used to configure the AWS KMS Client.|_none_ +|`aws.access.key.id`|The access key ID credential used to access AWS KMS.|_none_ +|`aws.secret.key.id`|The secret key ID credential used to access AWS KMS.|_none_ Review comment: ```suggestion |`aws.secret.key`|The secret key credential used to access AWS KMS.|_none_ ``` ########## File path: nifi-commons/nifi-sensitive-property-provider/src/test/java/org/apache/nifi/properties/AWSSensitivePropertyProviderIT.java ########## @@ -0,0 +1,133 @@ +/* + * 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.properties; + +import org.junit.AfterClass; +import org.junit.Assert; +import org.junit.BeforeClass; +import org.junit.Test; +import org.mockito.internal.util.io.IOUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Properties; + +/** + * To run this test, make sure to first configure sensitive credential information as in the following link + * https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html + * + * If you don't have a key then run: + * aws kms create-key + * + * Take note of the key id or arn. + * + * Then, set the system property -Daws.kms.key.id to the either key id value or arn value + * + * The following settings are optional. If you have a default AWS configuration and credentials in ~/.aws then + * it will take that. Otherwise you can set all of the following: + * set the system property -Daws.access.key.id to the access key id + * set the system property -Daws.secret.key.id to the secret key id Review comment: Should be changed to `aws.secret.key`: ```suggestion * set the system property -Daws.secret.key to the secret key ``` ########## File path: nifi-commons/nifi-sensitive-property-provider/src/test/java/org/apache/nifi/properties/AWSSensitivePropertyProviderIT.java ########## @@ -0,0 +1,133 @@ +/* + * 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.properties; + +import org.junit.AfterClass; +import org.junit.Assert; +import org.junit.BeforeClass; +import org.junit.Test; +import org.mockito.internal.util.io.IOUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Properties; + +/** + * To run this test, make sure to first configure sensitive credential information as in the following link + * https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html + * + * If you don't have a key then run: + * aws kms create-key + * + * Take note of the key id or arn. + * + * Then, set the system property -Daws.kms.key.id to the either key id value or arn value + * + * The following settings are optional. If you have a default AWS configuration and credentials in ~/.aws then + * it will take that. Otherwise you can set all of the following: + * set the system property -Daws.access.key.id to the access key id + * set the system property -Daws.secret.key.id to the secret key id + * set the system property -Daws.region to the region + * + * After you are satisfied with the test, and you don't need the key, you may schedule key deletion with: + * aws kms schedule-key-deletion --key-id "key id" --pending-window-in-days "number of days" + * + */ + +public class AWSSensitivePropertyProviderIT { + private static final String SAMPLE_PLAINTEXT = "AWSSensitivePropertyProviderIT SAMPLE-PLAINTEXT"; + private static final String ACCESS_KEY_PROPS_NAME = "aws.access.key.id"; + private static final String SECRET_KEY_PROPS_NAME = "aws.secret.key.id"; Review comment: ```suggestion private static final String SECRET_KEY_PROPS_NAME = "aws.secret.key"; ``` ########## File path: nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/conf/bootstrap-aws.conf ########## @@ -0,0 +1,28 @@ +# +# 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. +# + +# AWS KMS Key ID is required to be configured for AWS KMS Sensitive Property Provider +aws.kms.key.id= + +# First attempts to use credentials/configuration in bootstrap-aws.conf. +# If credentials/configuration in bootstrap-aws.conf is not fully configured, +# attempt to initialize credentials using default AWS credentials/configuration chain. + +# Optional AWS KMS Client Configuration/Credentials (all of them must be set in order to be used) Review comment: Recommend rewording to clarify the implementation: ```suggestion # NiFi uses the following properties when authentication to AWS when all values are provided. # NiFi uses the default AWS credentials provider chain when one or more or the following properties are blank # AWS SDK documentation describes the default credential retrieval order: # https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html#credentials-chain ``` ########## File path: nifi-docs/src/main/asciidoc/toolkit-guide.adoc ########## @@ -699,6 +719,40 @@ for each phase (old vs. new), and any combination is sufficient: In order to change the protection scheme (e.g., migrating from AES encryption to Vault encryption), specify the `--protectionScheme` and `--oldProtectionScheme` in the migration command. +The following is an example of the commands for protection scheme migration from AES_GCM to AWS_KMS then back. Execute these commands at the `nifi` directory with the `nifi-toolkit` directory as a sibling directory. In addition, make sure to update `bootstrap-aws.conf` with your AWS KMS Key ARN/ID and have your credentials and region configured. + + +This command encrypts nifi.properties with the AES_GCM protection scheme +---- +./../nifi-toolkit-*-SNAPSHOT/bin/encrypt-config.sh \ +-b conf/bootstrap.conf \ +-n conf/nifi.properties \ +-k 0123456789ABCDEFFEDCBA98765432100123456789ABCDEFFEDCBA9876543210 \ +-v +---- +This command migrates nifi.properties from using AES_GCM to using AWS_KMS protection scheme +---- +./../nifi-toolkit-*-SNAPSHOT/bin/encrypt-config.sh \ +-b conf/bootstrap.conf \ +-n conf/nifi.properties \ +-S AWS_KMS \ +-H AES_GCM \ +-e 0123456789ABCDEFFEDCBA98765432100123456789ABCDEFFEDCBA9876543210 \ +-m \ +-v +---- +This command migrates nifi.properties back from AWS_KMS to AES_GCM protection scheme +---- +./../nifi-toolkit-*-SNAPSHOT/bin/encrypt-config.sh \ +-b conf/bootstrap.conf \ +-n conf/nifi.properties \ +-S AES_GCM \ +-k 0123456789ABCDEFFEDCBA98765432100123456789ABCDEFFEDCBA9876543210 \ +-H AES_GCM \ Review comment: Based on the description, it looks like the previous scheme should be AWS_KMS for the example command. ```suggestion -H AWS_KMS \ ``` ########## File path: nifi-registry/nifi-registry-core/nifi-registry-resources/src/main/resources/conf/bootstrap-aws.conf ########## @@ -0,0 +1,28 @@ +# +# 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. +# + +# AWS KMS Key ID is required to be configured for AWS KMS Sensitive Property Provider +aws.kms.key.id= + +# First attempts to use credentials/configuration in bootstrap-aws.conf. +# If credentials/configuration in bootstrap-aws.conf is not fully configured, +# attempt to initialize credentials using default AWS credentials/configuration chain. + +# Optional AWS KMS Client Configuration/Credentials (all of them must be set in order to be used) Review comment: Recommend rewording to clarify the implementation: ```suggestion # NiFi uses the following properties when authentication to AWS when all values are provided. # NiFi uses the default AWS credentials provider chain when one or more or the following properties are blank # AWS SDK documentation describes the default credential retrieval order: # https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html#credentials-chain ``` -- 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]
