exceptionfactory opened a new pull request #4857:
URL: https://github.com/apache/nifi/pull/4857
#### Description of PR
NIFI-8230 Removes the default internal Sensitive Properties Key which
provided fallback support when the value of `nifi.sensitive.props.key` was
empty. NiFi used the default internal value on new installations where the
administrator had not configured a sensitive properties key.
To maintain ease of use, this PR includes an update to
`NiFiPropertiesLoader.get()` that checks for a null or blank sensitive
properties key and generates a random key when the flow configuration file is
not found. The random key generation process uses `java.util.SecureRandom` to
generate an array of 24 bytes, which is then encoded using Base64 without
padding to produce a 32 character string. Using Base64 without padding avoids
introducing unsupported property characters while also providing a reasonable
range of potential random characters.
This approach supports generating a random key for installations of NiFi
while avoiding random generation when upgrading. Existing flow configurations
may already contain sensitive properties encrypted with the default internal
key. For upgrades of existing installations that do not have a sensitive
properties key, NiFi logs and error and throws an exception referencing the
Administration Guide section on _Migrating a Flow with Sensitive Properties_.
To support migration, the `ConfigEncryptionTool` retains the default internal
value for reading existing flows.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [X] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
- [X] 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.
- [X] Has your PR been rebased against the latest commit within the target
branch (typically `main`)?
- [X] 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:
- [X] Have you ensured that the full suite of tests is executed via `mvn
-Pcontrib-check clean install` at the root `nifi` folder?
- [X] Have you written or updated unit tests to verify your changes?
- [X] Have you verified that the full build is successful on JDK 8?
- [X] 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](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] 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.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
