Skip to content

fixed plugins unknown setting and disabled_rest_categories #6021

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.

Sign up for GitHub

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

Merged
cwperks merged 3 commits into from
Mar 23, 2026
+25 −3
Merged

fixed plugins unknown setting and disabled_rest_categories #6021

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
12779aa
fixed plugins unknown setting and disabled_rest_categories
ThyTran1402 Mar 18, 2026
2a50362
updated changelog.md
ThyTran1402 Mar 18, 2026
7f1048c
Merge branch 'main' into fix/audit_log_setting
ThyTran1402 Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
### Bug Fixes
- Fix audit log writing errors for rollover-enabled alias indices ([#5878](https://github.com/opensearch-project/security/pull/5878)
- Fix the issue of unprocessed X-Request-Id ([#5954](https://github.com/opensearch-project/security/pull/5954))
- Fix audit log `NONE` sentinel not respected for `disabled_rest_categories`, `disabled_transport_categories`, and `ignore_users` in dynamic configuration ([#6021](https://github.com/opensearch-project/security/pull/6021))
- Improve DLS error message to identify undefined user attributes when query substitution fails ([#5975](https://github.com/opensearch-project/security/pull/5975))
- Fix span propagation issue for tracing([#6006](https://github.com/opensearch-project/security/pull/6006))

Expand Down
7 changes: 4 additions & 3 deletions src/main/java/org/opensearch/security/auditlog/config/AuditConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,9 +256,10 @@ public static Filter from(Map<String, Object> properties) throws JsonProcessingE
ConfigConstants.OPENDISTRO_SECURITY_AUDIT_DISABLED_CATEGORIES_DEFAULT
)
);
final Set<String> ignoredAuditUsers = ImmutableSet.copyOf(
getOrDefault(properties, FilterEntries.IGNORE_USERS.getKey(), DEFAULT_IGNORED_USERS)
);
final List<String> rawIgnoredUsers = getOrDefault(properties, FilterEntries.IGNORE_USERS.getKey(), DEFAULT_IGNORED_USERS);
final Set<String> ignoredAuditUsers = rawIgnoredUsers.size() == 1 && "NONE".equalsIgnoreCase(rawIgnoredUsers.get(0))
Copy link
Member

@DarshitChanpura DarshitChanpura Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not filter out NONE from rawIngoredUsers?

Copy link
Contributor Author

@ThyTran1402 ThyTran1402 Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmmm I think NONE is the sentinel config value, not actual username. It means don't ignore any users. So, rawIngoredUsers holds exactly what's in the config, keeping the input separate from the output logic. If we filtered it, we could lose the information that the user explicitly configured rather than just providing an empty list.

Copy link
Contributor Author

@ThyTran1402 ThyTran1402 Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, NONE is like special handling not regular filter.

? Collections.emptySet()
: ImmutableSet.copyOf(rawIgnoredUsers);
final Set<String> ignoreAuditRequests = ImmutableSet.copyOf(
getOrDefault(properties, FilterEntries.IGNORE_REQUESTS.getKey(), Collections.emptyList())
);
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/org/opensearch/security/auditlog/impl/AuditCategory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ public enum AuditCategory {

public static Set<AuditCategory> parse(final Collection<String> categories) {
if (categories.isEmpty()) return Collections.emptySet();
if (categories.size() == 1 && "NONE".equalsIgnoreCase(categories.iterator().next())) {
return Collections.emptySet();
}

return categories.stream().map(String::toUpperCase).map(AuditCategory::valueOf).collect(ImmutableSet.toImmutableSet());
}
Expand Down
17 changes: 17 additions & 0 deletions src/test/java/org/opensearch/security/auditlog/config/AuditConfigFilterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@

import java.util.Collections;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;

Expand Down Expand Up @@ -118,6 +120,21 @@ public void testNone() {
assertTrue(auditConfigFilter.getDisabledTransportCategories().isEmpty());
}

@Test
public void testNoneViaMap() throws Exception {
// "NONE" sentinel should clear disabled categories and ignored users when set via the REST/Map path
final Map<String, Object> properties = new HashMap<>();
properties.put(FilterEntries.IGNORE_USERS.getKey(), List.of("NONE"));
properties.put(FilterEntries.DISABLE_REST_CATEGORIES.getKey(), List.of("None"));
properties.put(FilterEntries.DISABLE_TRANSPORT_CATEGORIES.getKey(), List.of("none"));

final AuditConfig.Filter auditConfigFilter = AuditConfig.Filter.from(properties);

assertSame(WildcardMatcher.NONE, auditConfigFilter.getIgnoredAuditUsersMatcher());
assertTrue(auditConfigFilter.getDisabledRestCategories().isEmpty());
assertTrue(auditConfigFilter.getDisabledTransportCategories().isEmpty());
}

@Test
public void testEmpty() {
// arrange
Expand Down
Loading