-
Notifications
You must be signed in to change notification settings - Fork 2.4k
[Rule-based Autotagging] add security attributes to rules #19232
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 0 additions & 1 deletion
1
modules/autotagging-commons/common/licenses/commons-collections4-4.4.jar.sha1
This file was deleted.
Oops, something went wrong.
1 change: 1 addition & 0 deletions
1
modules/autotagging-commons/common/licenses/commons-collections4-4.5.0.jar.sha1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| e5cf89f0c6e132fc970bd9a465fdcb8dbe94f75a |
125 changes: 125 additions & 0 deletions
125
modules/autotagging-commons/common/src/main/java/org/opensearch/rule/SecurityAttribute.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| package org.opensearch.rule; | ||
|
|
||
| import org.opensearch.core.xcontent.XContentBuilder; | ||
| import org.opensearch.core.xcontent.XContentParseException; | ||
| import org.opensearch.core.xcontent.XContentParser; | ||
| import org.opensearch.rule.autotagging.Attribute; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.HashMap; | ||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
|
|
||
| /** | ||
| * Security attribute for the rules. Example: | ||
| * principal: { | ||
| * "username": ["alice", "bob"], | ||
| * "role": ["admin"] | ||
| * } | ||
| * @opensearch.experimental | ||
| */ | ||
| public enum SecurityAttribute implements Attribute { | ||
| /** | ||
| * Represents the index_pattern attribute in RuleAttribute | ||
| */ | ||
| PRINCIPAL("principal"); | ||
|
|
||
| /** | ||
| * Key representing the username subfield. | ||
| */ | ||
| public static final String USERNAME = "username"; | ||
| /** | ||
| * Key representing the role subfield. | ||
| */ | ||
| public static final String ROLE = "role"; | ||
| private final String name; | ||
| private static final List<String> ALLOWED_SUBFIELDS = List.of(USERNAME, ROLE); | ||
|
|
||
| SecurityAttribute(String name) { | ||
| this.name = name; | ||
| validateAttribute(); | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return name; | ||
| } | ||
|
|
||
| @Override | ||
| public List<String> getPrioritizedSubfields() { | ||
| return ALLOWED_SUBFIELDS; | ||
| } | ||
|
|
||
| @Override | ||
| public Set<String> fromXContentParseAttributeValues(XContentParser parser) throws IOException { | ||
| Set<String> resultSet = new HashSet<>(); | ||
|
|
||
| if (parser.currentToken() != XContentParser.Token.START_OBJECT) { | ||
| throw new XContentParseException( | ||
| parser.getTokenLocation(), | ||
| "Expected START_OBJECT token for " + getName() + " attribute but got " + parser.currentToken() | ||
| ); | ||
| } | ||
| while (parser.nextToken() != XContentParser.Token.END_OBJECT) { | ||
| String subFieldName = parser.currentName(); | ||
| parser.nextToken(); | ||
| if (!ALLOWED_SUBFIELDS.contains(subFieldName)) { | ||
| throw new XContentParseException( | ||
| parser.getTokenLocation(), | ||
| "Invalid field: " + subFieldName + ". Allowed fields are: " + String.join(", ", ALLOWED_SUBFIELDS) | ||
| ); | ||
| } | ||
| if (parser.currentToken() != XContentParser.Token.START_ARRAY) { | ||
| throw new XContentParseException( | ||
| parser.getTokenLocation(), | ||
| "Expected array for field: " + subFieldName + " but got " + parser.currentToken() | ||
| ); | ||
| } | ||
| while (parser.nextToken() != XContentParser.Token.END_ARRAY) { | ||
| if (parser.currentToken() == XContentParser.Token.VALUE_STRING) { | ||
| // prefix each value with the subFieldName (e.g., "username_name1") | ||
| resultSet.add(String.join("_", subFieldName, parser.text())); | ||
| } else { | ||
| throw new XContentParseException( | ||
| parser.getTokenLocation(), | ||
| "Expected string value in array under '" + subFieldName + "', but got " + parser.currentToken() | ||
| ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return resultSet; | ||
| } | ||
|
|
||
| @Override | ||
| public void toXContentWriteAttributeValues(XContentBuilder builder, Set<String> values) throws IOException { | ||
ruai0511 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| builder.startObject(getName()); | ||
| Map<String, Set<String>> grouped = new HashMap<>(); | ||
|
|
||
| // For each string in the values set, split it into two parts using the first underscore as delimiter: | ||
| // parts[0] is the prefix (e.g., "username" or "role") | ||
| // parts[1] is the actual value (e.g., "name1", "role1") | ||
| for (String value : values) { | ||
| String[] parts = value.split("_", 2); | ||
| if (parts.length == 2) { | ||
| grouped.computeIfAbsent(parts[0], k -> new HashSet<>()).add(parts[1]); | ||
| } | ||
| } | ||
|
|
||
| for (Map.Entry<String, Set<String>> entry : grouped.entrySet()) { | ||
| builder.array(entry.getKey(), entry.getValue().toArray(new String[0])); | ||
| } | ||
|
|
||
| builder.endObject(); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we make this more generic so that there's no reference to username or role?
I'm not sure how WLM works, but I know that a request will match to the best workload group. How does the scoring work for matching? Can we assign weights to different attributes to help with the matching problem to determine the best group?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believed we need to reference to username or role because they are auto tagging's attributes. I just made them Attribute instead of a String to make it clearer