Skip to content

[Backport 2.19] Add tenancy access info to serialized user in threadcontext #5520

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
shikharj05 merged 2 commits into from
Jul 31, 2025
Merged

[Backport 2.19] Add tenancy access info to serialized user in threadcontext #5520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9638bc
Add tenancy access info to serialized user in threadcontext (#5519)
cwperks Jul 30, 2025
9788fd5
Fix conflicts
cwperks Jul 30, 2025
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 @@ -8,3 +8,4 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
### Maintenance
- Bump `com.nimbusds:nimbus-jose-jwt:9.48` from 9.48 to 10.0.2 ([#5480](https://github.com/opensearch-project/security/pull/5480))
- Bump `checkstyle` from 10.3.3 to 10.26.1 ([#5480](https://github.com/opensearch-project/security/pull/5480))
- Add tenancy access info to serialized user in threadcontext ([#5519](https://github.com/opensearch-project/security/pull/5519))
29 changes: 24 additions & 5 deletions src/main/java/org/opensearch/security/privileges/PrivilegesEvaluatorImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,11 @@ public class PrivilegesEvaluatorImpl implements PrivilegesEvaluator {
);

private static final WildcardMatcher ACTION_MATCHER = WildcardMatcher.from("indices:data/read/*search*");
private static final String USER_TENANT = "__user__";
private static final String GLOBAL_TENANT = "global_tenant";
private static final String READ_ACCESS = "READ";
private static final String WRITE_ACCESS = "WRITE";
private static final String NO_ACCESS = "NONE";

private static final IndicesOptions ALLOW_EMPTY = IndicesOptions.fromOptions(true, true, false, false);

Expand Down Expand Up @@ -273,7 +278,7 @@ public boolean isInitialized() {
return configModel != null && dcm != null && actionPrivileges.get() != null;
}

private void setUserInfoInThreadContext(User user) {
private void setUserInfoInThreadContext(User user, Set<String> mappedRoles) {
if (threadContext.getTransient(OPENDISTRO_SECURITY_USER_INFO_THREAD_CONTEXT) == null) {
StringJoiner joiner = new StringJoiner("|");
// Escape any pipe characters in the values before joining
Expand All @@ -282,9 +287,10 @@ private void setUserInfoInThreadContext(User user) {
joiner.add(escapePipe(String.join(",", user.getSecurityRoles())));

String requestedTenant = user.getRequestedTenant();
if (!Strings.isNullOrEmpty(requestedTenant)) {
joiner.add(escapePipe(requestedTenant));
}
joiner.add(requestedTenant);
String tenantAccessToCheck = getTenancyAccess(requestedTenant, mapTenants(user, mappedRoles));
joiner.add(tenantAccessToCheck);
log.debug(joiner);
threadContext.putTransient(OPENDISTRO_SECURITY_USER_INFO_THREAD_CONTEXT, joiner.toString());
}
}
Expand All @@ -310,6 +316,19 @@ public PrivilegesEvaluationContext createContext(
return new PrivilegesEvaluationContext(user, mappedRoles, action0, request, task, irr, resolver, clusterStateSupplier);
}

private String getTenancyAccess(String requestedTenant, Map<String, Boolean> tenancyAccessMap) {
final String tenant = Strings.isNullOrEmpty(requestedTenant) ? GLOBAL_TENANT : requestedTenant;
if (tenant.equals(USER_TENANT)) {
return WRITE_ACCESS;
} else {
if (tenancyAccessMap == null || !tenancyAccessMap.containsKey(tenant)) {
return NO_ACCESS;
} else {
return tenancyAccessMap.get(tenant) ? WRITE_ACCESS : READ_ACCESS;
}
}
}

public PrivilegesEvaluatorResponse evaluate(PrivilegesEvaluationContext context) {

if (!isInitialized()) {
Expand Down Expand Up @@ -353,7 +372,7 @@ public PrivilegesEvaluatorResponse evaluate(PrivilegesEvaluationContext context)

// Add the security roles for this user so that they can be used for DLS parameter substitution.
user.addSecurityRoles(mappedRoles);
setUserInfoInThreadContext(user);
setUserInfoInThreadContext(user, mappedRoles);

final boolean isDebugEnabled = log.isDebugEnabled();
if (isDebugEnabled) {
Expand Down
29 changes: 24 additions & 5 deletions src/main/java/org/opensearch/security/privileges/legacy/PrivilegesEvaluatorImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,11 @@ public class PrivilegesEvaluatorImpl implements PrivilegesEvaluator {
);

private static final WildcardMatcher ACTION_MATCHER = WildcardMatcher.from("indices:data/read/*search*");
private static final String USER_TENANT = "__user__";
private static final String GLOBAL_TENANT = "global_tenant";
private static final String READ_ACCESS = "READ";
private static final String WRITE_ACCESS = "WRITE";
private static final String NO_ACCESS = "NONE";

private static final IndicesOptions ALLOW_EMPTY = IndicesOptions.fromOptions(true, true, false, false);

Expand Down Expand Up @@ -209,7 +214,7 @@ public SecurityRoles getSecurityRoles(User user, Set<String> roles) {

// Add the security roles for this user so that they can be used for DLS parameter substitution.
user.addSecurityRoles(roles);
setUserInfoInThreadContext(user);
setUserInfoInThreadContext(user, roles);
}

return securityRoles;
Expand Down Expand Up @@ -243,7 +248,7 @@ public boolean isInitialized() {
return configModel != null && configModel.getSecurityRoles() != null && dcm != null;
}

private void setUserInfoInThreadContext(User user) {
private void setUserInfoInThreadContext(User user, Set<String> mappedRoles) {
if (threadContext.getTransient(OPENDISTRO_SECURITY_USER_INFO_THREAD_CONTEXT) == null) {
StringJoiner joiner = new StringJoiner("|");
// Escape any pipe characters in the values before joining
Expand All @@ -252,9 +257,10 @@ private void setUserInfoInThreadContext(User user) {
joiner.add(escapePipe(String.join(",", user.getSecurityRoles())));

String requestedTenant = user.getRequestedTenant();
if (!Strings.isNullOrEmpty(requestedTenant)) {
joiner.add(escapePipe(requestedTenant));
}
joiner.add(requestedTenant);
String tenantAccessToCheck = getTenancyAccess(requestedTenant, mapTenants(user, mappedRoles));
joiner.add(tenantAccessToCheck);
log.debug(joiner);
threadContext.putTransient(OPENDISTRO_SECURITY_USER_INFO_THREAD_CONTEXT, joiner.toString());
}
}
Expand All @@ -280,6 +286,19 @@ public PrivilegesEvaluationContext createContext(
return new PrivilegesEvaluationContext(user, mappedRoles, action0, request, task, irr, resolver, () -> clusterService.state());
}

private String getTenancyAccess(String requestedTenant, Map<String, Boolean> tenancyAccessMap) {
final String tenant = Strings.isNullOrEmpty(requestedTenant) ? GLOBAL_TENANT : requestedTenant;
if (tenant.equals(USER_TENANT)) {
return WRITE_ACCESS;
} else {
if (tenancyAccessMap == null || !tenancyAccessMap.containsKey(tenant)) {
return NO_ACCESS;
} else {
return tenancyAccessMap.get(tenant) ? WRITE_ACCESS : READ_ACCESS;
}
}
}

public PrivilegesEvaluatorResponse evaluate(PrivilegesEvaluationContext context) {

if (!isInitialized()) {
Expand Down
Loading