[NIFI-12243] Refactor encrypt-config Command Implementation

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.0.0-M1
• Component/s: NiFi Registry, Tools and Build
• Assignee: David Handermann
• Reporter: David Handermann
• Created: 19/Oct/23 04:55
• Updated: 19/Apr/24 15:37
• Resolved: 22/Oct/23 08:55

Description

The encrypt-config command in nifi-toolkit-encrypt-config supports protection of sensitive properties in multiple application configuration files. The current implementation supports NiFi and NiFi Registry with similar capabilities.

The existing implementation is written in Groovy and includes some amount of duplication between operating modes.

The command supports capabilities unique to NiFi for protection for specific property values in application properties and flow configuration files.

The encrypt-config command components should be refactored using the picocli framework to streamline the implementation. This refactoring should focus on supporting existing command arguments to provide compatibility with existing usage patterns. Separate efforts could consider a redesigned approach with different arguments and sub-commands, but refactoring the current implementation will provide a more maintainable solution.

Issue Links

• fixes: NIFI-3714 Encrypt config tool replaces wrong key/value pair with encrypted value and exposes plain sensitive value
• relates to: NIFI-10047 Refactor Groovy Tests to Java
• relates to: NIFI-9084 Refactor unit and integration tests to use JUnit 5 instead of JUnit 4
• links to: GitHub Pull Request #7901