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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
