NIFI-13414 Removed Property Protection Modules and Encrypt Config

This closes #8978 - Removed nifi-property-protection-api and implementation modules - Removed nifi-toolkit-encrypt-config and minifi-toolkit-encrypt-config modules - Removed extra bootstrap.conf configuration files for property protection implementations Signed-off-by: Joseph Witt <joewitt@apache.org>
apache · Jun 20, 2024 · 49a0401 · 49a0401
1 parent b7a48f7
commit 49a0401
Show file tree

Hide file tree

Showing 181 changed files with 77 additions and 11,967 deletions.
diff --git a/.github/workflows/docker-tests.yml b/.github/workflows/docker-tests.yml
@@ -27,7 +27,6 @@ on:
       - 'nifi-registry/nifi-registry-docker-maven/**'
       - 'nifi-toolkit/nifi-toolkit-assembly/**'
       - 'nifi-toolkit/nifi-toolkit-cli/**'
-      - 'nifi-toolkit/nifi-toolkit-encrypt-config/**'
       - 'minifi/minifi-assembly/**'
       - 'minifi/minifi-docker/**'
   pull_request:
@@ -39,7 +38,6 @@ on:
       - 'nifi-registry/nifi-registry-docker-maven/**'
       - 'nifi-toolkit/nifi-toolkit-assembly/**'
       - 'nifi-toolkit/nifi-toolkit-cli/**'
-      - 'nifi-toolkit/nifi-toolkit-encrypt-config/**'
       - 'minifi/minifi-assembly/**'
       - 'minifi/minifi-docker/**'
 
@@ -77,7 +75,6 @@ env:
     -pl -nifi-registry/nifi-registry-assembly
     -pl -nifi-toolkit/nifi-toolkit-assembly
     -pl -nifi-toolkit/nifi-toolkit-cli
-    -pl -nifi-toolkit/nifi-toolkit-encrypt-config
     -pl -minifi/minifi-assembly
 
   MAVEN_DOCKER_ARGUMENTS: >-

diff --git a/...otstrap/src/main/java/org/apache/nifi/minifi/bootstrap/service/BootstrapFileProvider.java b/...otstrap/src/main/java/org/apache/nifi/minifi/bootstrap/service/BootstrapFileProvider.java
@@ -120,7 +120,7 @@ public BootstrapProperties getBootstrapProperties() {
     }
 
     public BootstrapProperties getProtectedBootstrapProperties() {
-        return BootstrapPropertiesLoader.loadProtectedProperties(bootstrapConfigFile).getApplicationProperties();
+        return BootstrapPropertiesLoader.loadProtectedProperties(bootstrapConfigFile);
     }
 
     public Properties getStatusProperties() {

diff --git a/...mons-utils/src/main/java/org/apache/nifi/minifi/commons/utils/SensitivePropertyUtils.java b/...mons-utils/src/main/java/org/apache/nifi/minifi/commons/utils/SensitivePropertyUtils.java
diff --git a/...ifi-nar-bundles/minifi-framework-bundle/minifi-framework/minifi-properties-loader/pom.xml b/...ifi-nar-bundles/minifi-framework-bundle/minifi-framework/minifi-properties-loader/pom.xml
@@ -31,19 +31,6 @@
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.apache.nifi</groupId>
-            <artifactId>nifi-property-protection-loader</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>org.apache.nifi</groupId>
-            <artifactId>nifi-property-protection-cipher</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>org.apache.nifi</groupId>
-            <artifactId>nifi-property-protection-api</artifactId>
-            <version>2.0.0-SNAPSHOT</version>
-        </dependency>
         <dependency>
             <groupId>org.apache.nifi</groupId>
             <artifactId>nifi-properties</artifactId>

diff --git a/...ies-loader/src/main/java/org/apache/nifi/minifi/properties/BootstrapPropertiesLoader.java b/...ies-loader/src/main/java/org/apache/nifi/minifi/properties/BootstrapPropertiesLoader.java
@@ -17,33 +17,15 @@
 
 package org.apache.nifi.minifi.properties;
 
-import static java.lang.String.format;
-import static org.apache.nifi.minifi.commons.utils.SensitivePropertyUtils.MINIFI_BOOTSTRAP_SENSITIVE_KEY;
-import static org.apache.nifi.minifi.commons.utils.SensitivePropertyUtils.getFormattedKey;
-
 import java.io.File;
-import org.apache.nifi.properties.AesGcmSensitivePropertyProvider;
 
 public class BootstrapPropertiesLoader {
 
     public static BootstrapProperties load(File file) {
-        ProtectedBootstrapProperties protectedProperties = loadProtectedProperties(file);
-        if (protectedProperties.hasProtectedKeys()) {
-            String sensitiveKey = protectedProperties.getApplicationProperties().getProperty(MINIFI_BOOTSTRAP_SENSITIVE_KEY);
-            validateSensitiveKeyProperty(sensitiveKey);
-            String keyHex = getFormattedKey(sensitiveKey);
-            protectedProperties.addSensitivePropertyProvider(new AesGcmSensitivePropertyProvider(keyHex));
-        }
-        return protectedProperties.getUnprotectedProperties();
-    }
-
-    public static ProtectedBootstrapProperties loadProtectedProperties(File file) {
-        return new ProtectedBootstrapProperties(PropertiesLoader.load(file, "Bootstrap"));
+        return loadProtectedProperties(file);
     }
 
-    private static void validateSensitiveKeyProperty(String sensitiveKey) {
-        if (sensitiveKey == null || sensitiveKey.trim().isEmpty()) {
-            throw new IllegalArgumentException(format("bootstrap.conf contains protected properties but %s is not found", MINIFI_BOOTSTRAP_SENSITIVE_KEY));
-        }
+    public static BootstrapProperties loadProtectedProperties(File file) {
+        return new BootstrapProperties(PropertiesLoader.load(file, "Bootstrap"));
     }
 }
diff --git a/...erties-loader/src/main/java/org/apache/nifi/minifi/properties/MiNiFiPropertiesLoader.java b/...erties-loader/src/main/java/org/apache/nifi/minifi/properties/MiNiFiPropertiesLoader.java
@@ -17,7 +17,8 @@
 package org.apache.nifi.minifi.properties;
 
 import java.io.File;
-import org.apache.nifi.properties.AesGcmSensitivePropertyProvider;
+import java.util.Properties;
+
 import org.apache.nifi.util.NiFiBootstrapUtils;
 import org.apache.nifi.util.NiFiProperties;
 
@@ -26,40 +27,17 @@ public class MiNiFiPropertiesLoader {
     private static final String DEFAULT_APPLICATION_PROPERTIES_FILE_PATH = NiFiBootstrapUtils.getDefaultApplicationPropertiesFilePath();
 
     private NiFiProperties instance;
-    private String keyHex;
-
-    public MiNiFiPropertiesLoader(String keyHex) {
-        this.keyHex = keyHex;
-    }
-
-    /**
-     * Returns a {@link ProtectedMiNiFiProperties} instance loaded from the
-     * serialized form in the file. Responsible for actually reading from disk
-     * and deserializing the properties. Returns a protected instance to allow
-     * for decryption operations.
-     *
-     * @param file the file containing serialized properties
-     * @return the ProtectedMiNiFiProperties instance
-     */
-    ProtectedMiNiFiProperties loadProtectedProperties(File file) {
-        return new ProtectedMiNiFiProperties(PropertiesLoader.load(file, "Application"));
-    }
 
     /**
      * Returns an instance of {@link NiFiProperties} loaded from the provided
-     * {@link File}. If any properties are protected, will attempt to use the
-     * {@link AesGcmSensitivePropertyProvider} to unprotect them
-     * transparently.
+     * {@link File}.
      *
      * @param file the File containing the serialized properties
      * @return the NiFiProperties instance
      */
     public NiFiProperties load(File file) {
-        ProtectedMiNiFiProperties protectedProperties = loadProtectedProperties(file);
-        if (protectedProperties.hasProtectedKeys()) {
-            protectedProperties.addSensitivePropertyProvider(new AesGcmSensitivePropertyProvider(keyHex));
-        }
-        return new MultiSourceMinifiProperties(protectedProperties.getUnprotectedPropertiesAsMap());
+        final Properties properties = PropertiesLoader.load(file, "Application");
+        return new MultiSourceMinifiProperties(properties);
     }
 
     /**

diff --git a/...s-loader/src/main/java/org/apache/nifi/minifi/properties/MultiSourceMinifiProperties.java b/...s-loader/src/main/java/org/apache/nifi/minifi/properties/MultiSourceMinifiProperties.java
@@ -16,7 +16,7 @@
  */
 package org.apache.nifi.minifi.properties;
 
-import java.util.Map;
+import java.util.Properties;
 import java.util.Set;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
@@ -29,7 +29,7 @@
  */
 public class MultiSourceMinifiProperties extends NiFiProperties {
 
-    public MultiSourceMinifiProperties(Map<String, String> props) {
+    public MultiSourceMinifiProperties(Properties props) {
         super(props);
     }
 

diff --git a/...i-properties-loader/src/main/java/org/apache/nifi/minifi/properties/PropertiesLoader.java b/...i-properties-loader/src/main/java/org/apache/nifi/minifi/properties/PropertiesLoader.java
@@ -27,7 +27,7 @@
 
 public interface PropertiesLoader {
 
-    static final Logger logger = LoggerFactory.getLogger(PropertiesLoader.class);
+    Logger logger = LoggerFactory.getLogger(PropertiesLoader.class);
 
     static Properties load(File file, String propertiesType) {
         if (file == null || !file.exists() || !file.canRead()) {

diff --git a/...-loader/src/main/java/org/apache/nifi/minifi/properties/ProtectedBootstrapProperties.java b/...-loader/src/main/java/org/apache/nifi/minifi/properties/ProtectedBootstrapProperties.java