You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by "exceptionfactory (via GitHub)" <gi...@apache.org> on 2026/09/03 04:03:26 UTC
[PR] NIFI-16282 Add Property Encryption Provider framework extension [nifi]
exceptionfactory opened a new pull request, #11617:
URL: https://github.com/apache/nifi/pull/11617
# Summary
[NIFI-16282](https://issues.apache.org/jira/browse/NIFI-16282) Adds `PropertyEncryptionProvider` as a new framework interface in `nifi-framework-api` and provides an initial password-based implementation.
This initial set of changes includes the interface definition and framework extension loading without wiring the changes into framework components. Subsequent pull requests will introduce compatible integration with existing call sites. This provides the opportunity for review of the interface definition along with the first implementation that uses existing application properties.
The `FlowControllerConfiguration` class adds the `propertyEncryptionProvider` Bean, but allows it to be `null` when not configured since it is not yet used.
The new NAR bundle includes the Bouncy Castle Provider library to support existing usage of Argon2 for key derivation.
# Tracking
Please complete the following tracking steps prior to pull request creation.
### Issue Tracking
- [Apache NiFi Jira](https://issues.apache.org/jira/browse/NIFI) issue created
### Pull Request Tracking
- Pull Request title starts with Apache NiFi Jira issue number, such as `NIFI-00000`
- Pull Request commit message starts with Apache NiFi Jira issue number, as such `NIFI-00000`
- Pull request contains [commits signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) with a registered key indicating `Verified` status
### Pull Request Formatting
- Pull Request based on current revision of the `main` branch
- Pull Request refers to a feature branch with one commit containing changes
# Verification
Please indicate the verification steps performed prior to pull request creation.
### Build
- [X] Build completed using `./mvnw clean install -P contrib-check`
- [X] JDK 21
- [X] JDK 25
### Licensing
- [ ] New dependencies are compatible with the [Apache License 2.0](https://apache.org/licenses/LICENSE-2.0) according to the [License Policy](https://www.apache.org/legal/resolved.html)
- [ ] New dependencies are documented in applicable `LICENSE` and `NOTICE` files
### Documentation
- [ ] Documentation formatting appears as expected in rendered files
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-16282 Add Property Encryption Provider framework extension [nifi]
Posted by "pvillard31 (via GitHub)" <gi...@apache.org>.
pvillard31 merged PR #11617:
URL: https://github.com/apache/nifi/pull/11617
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-16282 Add Property Encryption Provider framework extension [nifi]
Posted by "pvillard31 (via GitHub)" <gi...@apache.org>.
pvillard31 commented on code in PR #11617:
URL: https://github.com/apache/nifi/pull/11617#discussion_r3923412449
##########
nifi-framework-api/src/main/java/org/apache/nifi/security/encryption/SensitivePropertyContext.java:
##########
@@ -0,0 +1,38 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.nifi.security.encryption;
+
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * Context describing the sensitive value supplied to encryption and decryption operations. Implementations backed by an
+ * external key management service can supply the attributes as encryption context and rely on the service to record
+ * them for auditing. The same context must be supplied for decryption as was supplied for encryption.
+ *
+ * @param category Category of the value being protected
+ * @param attributes Attributes describing the location of the value, stored as an unmodifiable copy and never null
+ */
+public record SensitivePropertyContext(
+ SensitivePropertyCategory category,
+ Map<SensitivePropertyAttribute, String> attributes
+) {
Review Comment:
Just curious, is the use of `Map<SensitivePropertyAttribute, String>` intended to limit the context to framework-defined attributes? Future providers might need additional context (cluster, tenant, data domain, key alias for key selection, or external audit records). Would Map<String, String> with constants for NiFi-defined keys provide that extension point while preserving standard names? Something like
```java
public record SensitivePropertyContext(
SensitivePropertyCategory category,
Map<SensitivePropertyAttribute, String> attributes,
Map<String, String> additionalAttributes
) {
}
```
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-16282 Add Property Encryption Provider framework extension [nifi]
Posted by "exceptionfactory (via GitHub)" <gi...@apache.org>.
exceptionfactory commented on code in PR #11617:
URL: https://github.com/apache/nifi/pull/11617#discussion_r3924850935
##########
nifi-framework-api/src/main/java/org/apache/nifi/security/encryption/SensitivePropertyContext.java:
##########
@@ -0,0 +1,38 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.nifi.security.encryption;
+
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * Context describing the sensitive value supplied to encryption and decryption operations. Implementations backed by an
+ * external key management service can supply the attributes as encryption context and rely on the service to record
+ * them for auditing. The same context must be supplied for decryption as was supplied for encryption.
+ *
+ * @param category Category of the value being protected
+ * @param attributes Attributes describing the location of the value, stored as an unmodifiable copy and never null
+ */
+public record SensitivePropertyContext(
+ SensitivePropertyCategory category,
+ Map<SensitivePropertyAttribute, String> attributes
+) {
Review Comment:
Thanks @pvillard31, that's a good point, I changed the `attributes` Map key to `String`. Although it is a bit more loose than the `additionalAttributes` approach, it follows the general framework pattern of attributes with reserved names.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-16282 Add Property Encryption Provider framework extension [nifi]
Posted by "pvillard31 (via GitHub)" <gi...@apache.org>.
pvillard31 commented on code in PR #11617:
URL: https://github.com/apache/nifi/pull/11617#discussion_r3923412449
##########
nifi-framework-api/src/main/java/org/apache/nifi/security/encryption/SensitivePropertyContext.java:
##########
@@ -0,0 +1,38 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.nifi.security.encryption;
+
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * Context describing the sensitive value supplied to encryption and decryption operations. Implementations backed by an
+ * external key management service can supply the attributes as encryption context and rely on the service to record
+ * them for auditing. The same context must be supplied for decryption as was supplied for encryption.
+ *
+ * @param category Category of the value being protected
+ * @param attributes Attributes describing the location of the value, stored as an unmodifiable copy and never null
+ */
+public record SensitivePropertyContext(
+ SensitivePropertyCategory category,
+ Map<SensitivePropertyAttribute, String> attributes
+) {
Review Comment:
Just curious, is the use of `Map<SensitivePropertyAttribute, String>` intended to limit the context to framework-defined attributes? Future providers might need additional context (cluster, tenant, data domain, key alias for key selection, or external audit records). Would Map<String, String> with constants for NiFi defined keys provide that extension point while preserving standard names? Something like
```java
public record SensitivePropertyContext(
SensitivePropertyCategory category,
Map<SensitivePropertyAttribute, String> attributes,
Map<String, String> additionalAttributes
) {
}
```
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-16282 Add Property Encryption Provider framework extension [nifi]
Posted by "pvillard31 (via GitHub)" <gi...@apache.org>.
pvillard31 commented on code in PR #11617:
URL: https://github.com/apache/nifi/pull/11617#discussion_r3923412449
##########
nifi-framework-api/src/main/java/org/apache/nifi/security/encryption/SensitivePropertyContext.java:
##########
@@ -0,0 +1,38 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.nifi.security.encryption;
+
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * Context describing the sensitive value supplied to encryption and decryption operations. Implementations backed by an
+ * external key management service can supply the attributes as encryption context and rely on the service to record
+ * them for auditing. The same context must be supplied for decryption as was supplied for encryption.
+ *
+ * @param category Category of the value being protected
+ * @param attributes Attributes describing the location of the value, stored as an unmodifiable copy and never null
+ */
+public record SensitivePropertyContext(
+ SensitivePropertyCategory category,
+ Map<SensitivePropertyAttribute, String> attributes
+) {
Review Comment:
Just curious, is the use of `Map<SensitivePropertyAttribute, String>` intended to limit the context to framework-defined attributes? Future providers might need additional context (cluster, tenant, data domain, key alias for key selection, or external audit records). Would `Map<String, String>` with constants for NiFi defined keys provide that extension point while preserving standard names? Something like
```java
public record SensitivePropertyContext(
SensitivePropertyCategory category,
Map<SensitivePropertyAttribute, String> attributes,
Map<String, String> additionalAttributes
) {
}
```
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org