DLS/FLS fixes

Signed-off-by: Nils Bandener <[email protected]>
opensearch-project · Sep 16, 2024 · 780a6b9 · 780a6b9
1 parent d8aa346
commit 780a6b9
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 3 deletions.
diff --git a/src/main/java/org/opensearch/security/privileges/IndexPattern.java b/src/main/java/org/opensearch/security/privileges/IndexPattern.java
@@ -1,3 +1,13 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
 package org.opensearch.security.privileges;
 
 import java.util.ArrayList;

diff --git a/src/main/java/org/opensearch/security/privileges/ParsedRole.java b/src/main/java/org/opensearch/security/privileges/ParsedRole.java
diff --git a/...n/java/org/opensearch/security/privileges/PrivilegesConfigurationValidationException.java b/...n/java/org/opensearch/security/privileges/PrivilegesConfigurationValidationException.java
@@ -1,3 +1,13 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
 package org.opensearch.security.privileges;
 
 /**

diff --git a/src/main/java/org/opensearch/security/privileges/dlsfls/DocumentPrivileges.java b/src/main/java/org/opensearch/security/privileges/dlsfls/DocumentPrivileges.java
@@ -16,6 +16,7 @@
 import java.util.Map;
 
 import org.apache.logging.log4j.util.Strings;
+
 import org.opensearch.cluster.metadata.IndexAbstraction;
 import org.opensearch.common.settings.Settings;
 import org.opensearch.common.xcontent.json.JsonXContent;

diff --git a/src/main/java/org/opensearch/security/privileges/dlsfls/FieldMasking.java b/src/main/java/org/opensearch/security/privileges/dlsfls/FieldMasking.java
@@ -1,3 +1,13 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
 package org.opensearch.security.privileges.dlsfls;
 
 import java.nio.charset.StandardCharsets;
@@ -29,6 +39,16 @@
 
 import com.rfksystems.blake2b.Blake2b;
 
+/**
+ * This class converts role configuration into pre-computed, optimized data structures for applying field masking
+ * to indexed documents.
+ * <p>
+ * With the exception of the statefulRules property, instances of this class are immutable. The life-cycle of an
+ * instance of this class corresponds to the life-cycle of the role configuration. If the role configuration is changed,
+ * a new instance needs to be built.
+ * <p>
+ * Instances of this class are managed by DlsFlsProcessedConfig.
+ */
 public class FieldMasking extends AbstractRuleBasedPrivileges<FieldMasking.FieldMaskingRule.SingleRole, FieldMasking.FieldMaskingRule> {
 
  private final FieldMasking.Config fieldMaskingConfig;

diff --git a/src/main/java/org/opensearch/security/privileges/dlsfls/IndexToRuleMap.java b/src/main/java/org/opensearch/security/privileges/dlsfls/IndexToRuleMap.java
@@ -1,3 +1,13 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
 package org.opensearch.security.privileges.dlsfls;
 
 import java.util.function.Predicate;