Skip to content

Deprecate filter_by_backend_roles, targeting removal in 4.0 - #1818

Open
DarshitChanpura wants to merge 1 commit into
opensearch-project:mainfrom
DarshitChanpura:deprecate-filter-by-backend-roles
Open

DarshitChanpura wants to merge 1 commit into
opensearch-project:mainfrom
DarshitChanpura:deprecate-filter-by-backend-roles

Conversation

@DarshitChanpura

Copy link
Copy Markdown
Member

Description

Marks backend-role filtering deprecated, targeting removal in 4.0. It is superseded by the security plugin's resource sharing and access control, which authorizes a resource by the access level it is shared at rather than by backend-role overlap, and detectors and correlation rules are already onboarded.

  • plugins.security_analytics.filter_by_backend_roles gets Setting.Property.Deprecated
  • javadoc records the 4.0 target, the replacement, and the threat intel dependency below

No behavior change: Property.Deprecated only emits a deprecation warning when the setting is set.

Removal in 4.0 needs threat intel onboarded to resource sharing first. TIF source configs, IOC findings, and threat-intel monitors and alerts still authorize through this setting, and only detector and correlation-rule are registered as shareable types, so dropping the setting today would leave those surfaces without an authorization path.

Testing

compileJava and compileTestJava are clean. The only other reference to the setting is SecurityAnalyticsRestTestCase, which sets it against a live cluster; CI covers that path.

Related

Tracking issue: opensearch-project/security#6530

Check List

  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Backend-role filtering is superseded by the security plugin's resource sharing
and access control, which authorizes a resource by the access level it is shared
at rather than by backend-role overlap. Detectors and correlation rules are
onboarded to resource sharing, so the setting is now the legacy path.

- plugins.security_analytics.filter_by_backend_roles gets
  Setting.Property.Deprecated
- javadoc names 4.0 as the removal target, the replacement, and the threat intel
  dependency below

Removal needs threat intel onboarded to resource sharing first: TIF source
configs, IOC findings and threat-intel monitors and alerts still authorize
through this setting, and only detector and correlation-rule are registered as
shareable types.

Tracking: opensearch-project/security#6530
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ No major issues detected

@codecov

codecov Bot commented Sep 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.60%. Comparing base (965377e) to head (ccb0afd).

❌ Your project check has failed because the head coverage (68.60%) is below the target coverage (75.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1818      +/-   ##
============================================
+ Coverage     68.58%   68.60%   +0.01%     
- Complexity     3750     3751       +1     
============================================
  Files           417      417              
  Lines         20888    20888              
  Branches       2189     2189              
============================================
+ Hits          14327    14331       +4     
+ Misses         5461     5457       -4     
  Partials       1100     1100              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant