markap14 commented on a change in pull request #5391: URL: https://github.com/apache/nifi/pull/5391#discussion_r719465065
########## File path: nifi-nar-bundles/nifi-aws-bundle/nifi-aws-parameter-value-providers/src/main/java/org/apache/nifi/stateless/parameter/aws/SecretsManagerParameterValueProvider.java ########## @@ -0,0 +1,172 @@ +/* + * 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.stateless.parameter.aws; + +import com.amazonaws.auth.AWSStaticCredentialsProvider; +import com.amazonaws.auth.BasicAWSCredentials; +import com.amazonaws.auth.DefaultAWSCredentialsProviderChain; +import com.amazonaws.services.secretsmanager.AWSSecretsManager; +import com.amazonaws.services.secretsmanager.AWSSecretsManagerClientBuilder; +import com.amazonaws.services.secretsmanager.model.GetSecretValueRequest; +import com.amazonaws.services.secretsmanager.model.GetSecretValueResult; +import com.amazonaws.services.secretsmanager.model.ListSecretsRequest; +import com.amazonaws.services.secretsmanager.model.ListSecretsResult; +import com.amazonaws.services.secretsmanager.model.SecretListEntry; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.stateless.parameter.AbstractParameterValueProvider; +import org.apache.nifi.stateless.parameter.ParameterValueProvider; +import org.apache.nifi.stateless.parameter.ParameterValueProviderInitializationContext; + +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.nio.file.Paths; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Properties; +import java.util.Set; + +/** + * Reads secrets from AWS Secrets Manager to provide parameter values. Secrets must be created similar to the following AWS cli command: <br/><br/> + * <code>aws secretsmanager create-secret --name "[ParamContextName]/[ParamName]" --secret-string '[ParamValue]'</code> <br/><br/> + * + * A standard configuration for this provider would be: <br/><br/> + * + * <code> + * nifi.stateless.parameter.provider.AWSSecretsManager.name=AWS Secrets Manager Value Provider + * nifi.stateless.parameter.provider.AWSSecretsManager.type=org.apache.nifi.stateless.parameter.aws.SecretsManagerParameterValueProvider + * nifi.stateless.parameter.provider.AWSSecretsManager.properties.aws-credentials-file=./conf/bootstrap-aws.conf + * </code> + */ +public class SecretsManagerParameterValueProvider extends AbstractParameterValueProvider implements ParameterValueProvider { + private static final String QUALIFIED_SECRET_FORMAT = "%s/%s"; + private static final String ACCESS_KEY_PROPS_NAME = "aws.access.key.id"; + private static final String SECRET_KEY_PROPS_NAME = "aws.secret.access.key"; + private static final String REGION_KEY_PROPS_NAME = "aws.region"; + + public static final PropertyDescriptor AWS_CREDENTIALS_FILE = new PropertyDescriptor.Builder() + .displayName("AWS Credentials File") + .name("aws-credentials-file") + .required(false) + .defaultValue("./conf/bootstrap-aws.conf") + .description("Location of the bootstrap-aws.conf file that configures the AWS credentials. If not provided, the default AWS credentials will be used.") + .addValidator(StandardValidators.FILE_EXISTS_VALIDATOR) + .build(); + + private final Set<String> supportedParameterNames = new HashSet<>(); + + private List<PropertyDescriptor> descriptors; + + private AWSSecretsManager secretsManager; + + @Override + protected List<PropertyDescriptor> getSupportedPropertyDescriptors() { + return descriptors; + } + + @Override + protected void init(final ParameterValueProviderInitializationContext context) { + super.init(context); + + this.descriptors = Collections.singletonList(AWS_CREDENTIALS_FILE); + + final String awsCredentialsFilename = context.getProperty(AWS_CREDENTIALS_FILE).getValue(); + try { + this.secretsManager = this.configureClient(awsCredentialsFilename); + } catch (final IOException e) { + throw new IllegalStateException("Could not configure AWS Secrets Manager Client", e); + } + + cacheSupportedParameterNames(); + } + + @Override + public boolean isParameterDefined(final String contextName, final String parameterName) { + return supportedParameterNames.contains(getSecretName(contextName, parameterName)); + } + + @Override + public String getParameterValue(final String contextName, final String parameterName) { + final String secretName = getSecretName(contextName, parameterName); + final GetSecretValueRequest getSecretValueRequest = new GetSecretValueRequest() + .withSecretId(secretName); + final GetSecretValueResult getSecretValueResult = secretsManager.getSecretValue(getSecretValueRequest); + + if (getSecretValueResult == null) { + throw new IllegalArgumentException(String.format("Secret [%s] not found", secretName)); + } + if (getSecretValueResult.getSecretString() != null) { + return getSecretValueResult.getSecretString(); + } else { + throw new IllegalStateException(String.format("Secret Name [%s] string value not found", secretName)); + } + } + + private void cacheSupportedParameterNames() { + supportedParameterNames.clear(); + final ListSecretsResult listSecretsResult = secretsManager.listSecrets(new ListSecretsRequest()); + if (listSecretsResult != null) { + for (final SecretListEntry entry : listSecretsResult.getSecretList()) { + supportedParameterNames.add(entry.getName()); + } + } + } + + private Properties loadProperties(final String propertiesFilename) throws IOException { + final Properties properties = new Properties(); + + try (final InputStream in = new FileInputStream(Paths.get(propertiesFilename).toFile())) { + properties.load(in); + return properties; + } + } + + AWSSecretsManager configureClient(final String awsCredentialsFilename) throws IOException { + if (awsCredentialsFilename == null) { + return getDefaultClient(); + } + final Properties properties = loadProperties(awsCredentialsFilename); + final String accessKey = properties.getProperty(ACCESS_KEY_PROPS_NAME); + final String secretKey = properties.getProperty(SECRET_KEY_PROPS_NAME); + final String region = properties.getProperty(REGION_KEY_PROPS_NAME); + + if (isNotBlank(accessKey) && isNotBlank(secretKey) && isNotBlank(region)) { + return AWSSecretsManagerClientBuilder.standard() + .withRegion(region) + .withCredentials(new AWSStaticCredentialsProvider(new BasicAWSCredentials(accessKey, secretKey))) + .build(); + } else { + return getDefaultClient(); + } + } + + private AWSSecretsManager getDefaultClient() { + return AWSSecretsManagerClientBuilder.standard() + .withCredentials(DefaultAWSCredentialsProviderChain.getInstance()) + .build(); + } + + private static String getSecretName(final String contextName, final String parameterName) { + return contextName == null ? parameterName : String.format(QUALIFIED_SECRET_FORMAT, contextName, parameterName); Review comment: Yes, exactly. Because 90% of the time a stateless flow will only use a single Parameter Context. So we don't want to require that they use the name of the parameter context each time. But, if they have a secret named "Password" or something like that, we do want to support disambiguating that. -- 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: issues-unsubscr...@nifi.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
