[NIFI-8230] Remove default Sensitive Properties Key

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.13.0
• Fix Version/s: 1.14.0
• Component/s: Security
• Assignee: David Handermann
• Reporter: David Handermann
• Created: 16/Feb/21 23:07
• Updated: 06/May/21 19:09
• Resolved: 04/May/21 12:50

Description

Support for encryption of sensitive properties relies on configuration of the Sensitive Properties Key specified using nifi.sensitive.props.key in nifi.properties.  The default behavior of StringEncryptor allows for the key to be blank and falls back to a default value, logging a verbose error message indicating that an explicit key should be provided.

The fallback to a default value for the Sensitive Properties Key should be removed and an exception should be thrown indicating that the property value is required.  Deployments that already have an explicit value will not be impacted.  Migration guidance for upgrading should include steps to encrypt the configuration using a new key.

It may be worthwhile generating a random Sensitive Properties Key for new installations where there is no existing flow.  This would new standalone installations to run with a secure key without the need for manual steps.

Issue Links

• fixes: NIFI-7670 Implement flow migration for PBE AEAD algorithms in Encrypt-Config toolkit
• is depended upon by: NIFI-8246 Set Default Sensitive Properties Algorithm with Improved KDF and Encryption
• is related to: NIFI-7668 Add configurable PBE AEAD algorithms to flow encryption
• relates to: NIFI-7670 Implement flow migration for PBE AEAD algorithms in Encrypt-Config toolkit
• links to: GitHub Pull Request #4857