NIFI-8312: Support PKCS12 and BCFKS truststores in Atlas reporting task #4893

turcsanyip · 2021-03-12T19:01:45Z

Generate ssl-client.xml on NiFi side in order to be able to configure non-JKS truststores.

https://issues.apache.org/jira/browse/NIFI-8312

Thank you for submitting a contribution to Apache NiFi.

Please provide a short description of the PR here:

Description of PR

Enables X functionality; fixes bug NIFI-YYYY.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
Has your PR been rebased against the latest commit within the target branch (typically main)?
Is your initial contribution a single, squashed commit? Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not squash or use --force when pushing to allow for clean monitoring of changes.

For code changes:

Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
Have you written or updated unit tests to verify your changes?
Have you verified that the full build is successful on JDK 8?
Have you verified that the full build is successful on JDK 11?
If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?

For documentation related changes:

Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check GitHub Actions CI for build issues and submit an update to your PR as soon as possible.

Generate ssl-client.xml on NiFi side in order to be able to configure non-JKS truststores.

The credential store is not related to Atlas REST API SSL connection but would eliminate a warning from Atlas Kafka client. Removed because it caused test failure on Windows due to missing Hadoop native libraries.

…ean-up.

exceptionfactory

Thanks for the contribution @turcsanyip. This looks like a straightforward improvement. See individual comments for a couple minor suggestions on logging, otherwise looks good.

exceptionfactory · 2021-03-15T21:46:59Z

...atlas-reporting-task/src/main/java/org/apache/nifi/atlas/reporting/ReportLineageToAtlas.java

+        try {
+            Files.deleteIfExists(path);
+        } catch (Exception e) {
+            getLogger().error("Unable to delete " + path, e);


Recommend changing the message to use the placeholder syntax and indicating a little more detail about the file:

Suggested change

getLogger().error("Unable to delete " + path, e);

getLogger().error("Unable to delete SSL Client Configuration File {}", path, e);

exceptionfactory · 2021-03-15T21:48:06Z

...atlas-reporting-task/src/main/java/org/apache/nifi/atlas/reporting/ReportLineageToAtlas.java

+        try (FileWriter fileWriter = new FileWriter(sslClientXmlFile)) {
+            configuration.writeXml(fileWriter);
+        } catch (Exception e) {
+            getLogger().error("Unable to create SSL config file: " + sslClientXmlFile, e);


As mention in other comment for parameterized logging:

Suggested change

getLogger().error("Unable to create SSL config file: " + sslClientXmlFile, e);

getLogger().error("Unable to create SSL Client Configuration File {}", sslClientXmlFile, e);

exceptionfactory · 2021-03-15T21:53:06Z

...atlas-reporting-task/src/main/java/org/apache/nifi/atlas/reporting/ReportLineageToAtlas.java

@@ -704,33 +699,47 @@ private void setAtlasSSLConfig(Properties atlasProperties, ConfigurationContext
        boolean isAtlasApiSecure = urls.stream().anyMatch(url -> url.toLowerCase().startsWith("https"));
        atlasProperties.put(ATLAS_PROPERTY_ENABLE_TLS, String.valueOf(isAtlasApiSecure));

-        // ssl-client.xml must be deleted, Atlas will not regenerate it otherwise
-        Path credStorePath = new File(confDir, CRED_STORE_FILENAME).toPath();
-        Files.deleteIfExists(credStorePath);


Do you anticipate any problems if the Credentials Store file remains on the file system since it will no longer be deleted?

Leaving the cred store file behind should not be a problem because we do not pass cert.stores.credential.provider.path property (pointing to the file) to Atlas any more so it will not use it.

Thanks for the confirmation.

turcsanyip · 2021-03-16T08:10:55Z

@exceptionfactory Thanks for the review. I modified the log statements according to your suggestions. Thanks for that.
Also replied to your question regarding the credential store.

- Generate ssl-client.xml on NiFi side in order to be able to configure non-JKS truststores. - Close FileOutputStream in tests to prevent error during clean-up. - Removed generating Hadoop Credential Store. - The credential store is not related to Atlas REST API SSL connection but would eliminate a warning from Atlas Kafka client. Removed because it caused test failure on Windows due to missing Hadoop native libraries. This closes apache#4893 Signed-off-by: David Handermann <exceptionfactory@apache.org>

turcsanyip added 3 commits March 12, 2021 20:00

NIFI-8312: Support PKCS12 and BCFKS truststores in Atlas reporting task

179fe10

Generate ssl-client.xml on NiFi side in order to be able to configure non-JKS truststores.

NIFI-8312: Removed generating Hadoop Credential Store.

0d11b9c

The credential store is not related to Atlas REST API SSL connection but would eliminate a warning from Atlas Kafka client. Removed because it caused test failure on Windows due to missing Hadoop native libraries.

NIFI-8312: Close FileOutputStream in tests to prevent error during cl…

5fbd03a

…ean-up.

exceptionfactory reviewed Mar 15, 2021

View reviewed changes

NIFI-8312: Review change: Improved logging.

9064fa4

exceptionfactory approved these changes Mar 17, 2021

View reviewed changes

asfgit closed this in 04cd418 Mar 17, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NIFI-8312: Support PKCS12 and BCFKS truststores in Atlas reporting task #4893

NIFI-8312: Support PKCS12 and BCFKS truststores in Atlas reporting task #4893

turcsanyip commented Mar 12, 2021 •

edited

exceptionfactory left a comment

exceptionfactory Mar 15, 2021

exceptionfactory Mar 15, 2021

exceptionfactory Mar 15, 2021

turcsanyip Mar 16, 2021

exceptionfactory Mar 17, 2021

turcsanyip commented Mar 16, 2021

	getLogger().error("Unable to delete " + path, e);
	getLogger().error("Unable to delete SSL Client Configuration File {}", path, e);

	getLogger().error("Unable to create SSL config file: " + sslClientXmlFile, e);
	getLogger().error("Unable to create SSL Client Configuration File {}", sslClientXmlFile, e);

NIFI-8312: Support PKCS12 and BCFKS truststores in Atlas reporting task #4893

NIFI-8312: Support PKCS12 and BCFKS truststores in Atlas reporting task #4893

Conversation

turcsanyip commented Mar 12, 2021 • edited

Description of PR

For all changes:

For code changes:

For documentation related changes:

Note:

exceptionfactory left a comment

Choose a reason for hiding this comment

exceptionfactory Mar 15, 2021

Choose a reason for hiding this comment

exceptionfactory Mar 15, 2021

Choose a reason for hiding this comment

exceptionfactory Mar 15, 2021

Choose a reason for hiding this comment

turcsanyip Mar 16, 2021

Choose a reason for hiding this comment

exceptionfactory Mar 17, 2021

Choose a reason for hiding this comment

turcsanyip commented Mar 16, 2021

turcsanyip commented Mar 12, 2021 •

edited