Skip to content
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

Simplify CompositeRolesStore#getRoleDescriptors #103126

Merged
merged 8 commits into from
Dec 8, 2023
Merged

Simplify CompositeRolesStore#getRoleDescriptors #103126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6069351
Simplify CompositeRolesStore#getRoleDescriptors
DaveCTurner Dec 7, 2023
df9f1a9
Merge branch 'main' into 2023/12/07/getRoleDescriptorsList-singleton
DaveCTurner Dec 7, 2023
37b7c4e
Merge branch 'main' into 2023/12/07/getRoleDescriptorsList-singleton
DaveCTurner Dec 7, 2023
cf1d537
Rename
DaveCTurner Dec 7, 2023
44e6fd7
Merge branch 'main' into 2023/12/07/getRoleDescriptorsList-singleton
DaveCTurner Dec 7, 2023
db9e0d9
Handle empty case with listener too
DaveCTurner Dec 7, 2023
b5ea31f
Merge branch 'main' into 2023/12/07/getRoleDescriptorsList-singleton
DaveCTurner Dec 8, 2023
7fd854d
Add comment with context for assertion
DaveCTurner Dec 8, 2023
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
10 changes: 2 additions & 8 deletions ...java/org/elasticsearch/xpack/security/authc/support/ApiKeyUserRoleDescriptorResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
import org.elasticsearch.xpack.core.security.authz.support.DLSRoleQueryValidator;
import org.elasticsearch.xpack.security.authz.store.CompositeRolesStore;

import java.util.Collection;
import java.util.Set;

public class ApiKeyUserRoleDescriptorResolver {
Expand All @@ -37,15 +36,10 @@ public void resolveUserRoleDescriptors(final Authentication authentication, fina
return;
}

rolesStore.getRoleDescriptorsList(effectiveSubject, listener.delegateFailureAndWrap(this::handleRoleDescriptorsList));
rolesStore.getRoleDescriptors(effectiveSubject, listener.delegateFailureAndWrap(this::handleRoleDescriptors));
DaveCTurner marked this conversation as resolved.
Show resolved Hide resolved
}

private void handleRoleDescriptorsList(
ActionListener<Set<RoleDescriptor>> listener,
Collection<Set<RoleDescriptor>> roleDescriptorsList
) {
assert roleDescriptorsList.size() == 1;
final var roleDescriptors = roleDescriptorsList.iterator().next();
private void handleRoleDescriptors(ActionListener<Set<RoleDescriptor>> listener, Set<RoleDescriptor> roleDescriptors) {
for (RoleDescriptor rd : roleDescriptors) {
DLSRoleQueryValidator.validateQueryField(rd.getIndicesPrivileges(), xContentRegistry);
}
Expand Down
35 changes: 11 additions & 24 deletions ...urity/src/main/java/org/elasticsearch/xpack/security/authz/store/CompositeRolesStore.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
import org.apache.logging.log4j.Logger;
import org.elasticsearch.ElasticsearchException;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.support.GroupedActionListener;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.bytes.BytesReference;
import org.elasticsearch.common.cache.Cache;
Expand Down Expand Up @@ -349,30 +348,18 @@ private void buildThenMaybeCacheRole(
);
}

public void getRoleDescriptorsList(Subject subject, ActionListener<Collection<Set<RoleDescriptor>>> listener) {
tryGetRoleDescriptorForInternalUser(subject).ifPresentOrElse(
roleDescriptor -> listener.onResponse(List.of(Set.of(roleDescriptor))),
() -> {
final List<RoleReference> roleReferences = subject.getRoleReferenceIntersection(anonymousUser).getRoleReferences();
final GroupedActionListener<Set<RoleDescriptor>> groupedActionListener = new GroupedActionListener<>(
roleReferences.size(),
listener
);
public void getRoleDescriptors(Subject subject, ActionListener<Set<RoleDescriptor>> listener) {
tryGetRoleDescriptorForInternalUser(subject).ifPresentOrElse(roleDescriptor -> listener.onResponse(Set.of(roleDescriptor)), () -> {
final List<RoleReference> roleReferences = subject.getRoleReferenceIntersection(anonymousUser).getRoleReferences();
assert roleReferences.size() == 1; // we only handle the singleton case today, but that may change with derived API keys

roleReferences.forEach(
roleReference -> roleReference.resolve(
roleReferenceResolver,
groupedActionListener.delegateFailureAndWrap((delegate, rolesRetrievalResult) -> {
if (rolesRetrievalResult.isSuccess()) {
delegate.onResponse(rolesRetrievalResult.getRoleDescriptors());
} else {
delegate.onFailure(new ElasticsearchException("role retrieval had one or more failures"));
}
})
)
);
}
);
ActionListener.run(listener.<RolesRetrievalResult>map(rolesRetrievalResult -> {
if (rolesRetrievalResult.isSuccess() == false) {
throw new ElasticsearchException("role retrieval had one or more failures");
}
return rolesRetrievalResult.getRoleDescriptors();
}), l -> roleReferences.iterator().next().resolve(roleReferenceResolver, l));
});
}

// Package private for testing
Expand Down
11 changes: 4 additions & 7 deletions ...org/elasticsearch/xpack/security/authc/support/ApiKeyUserRoleDescriptorResolverTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@
import org.elasticsearch.xpack.core.security.user.User;
import org.elasticsearch.xpack.security.authz.store.CompositeRolesStore;

import java.util.Collection;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;

Expand Down Expand Up @@ -56,11 +54,10 @@ public void testGetRoleDescriptors() {
assertThat(subject.getType(), is(Subject.Type.USER));
assertThat(Set.of(subject.getUser().roles()), equalTo(userRoleNames));

ActionListener<Collection<Set<RoleDescriptor>>> listener = (ActionListener<Collection<Set<RoleDescriptor>>>) args[args.length
- 1];
listener.onResponse(List.of(roleDescriptors));
ActionListener<Set<RoleDescriptor>> listener = (ActionListener<Set<RoleDescriptor>>) args[args.length - 1];
listener.onResponse(roleDescriptors);
return null;
}).when(rolesStore).getRoleDescriptorsList(any(Subject.class), any(ActionListener.class));
}).when(rolesStore).getRoleDescriptors(any(Subject.class), any(ActionListener.class));

final PlainActionFuture<Set<RoleDescriptor>> future = new PlainActionFuture<>();
resolver.resolveUserRoleDescriptors(authentication, future);
Expand All @@ -77,6 +74,6 @@ public void testGetRoleDescriptorsEmptyForApiKey() {
resolver.resolveUserRoleDescriptors(authentication, future);

assertThat(future.actionGet(), equalTo(Set.of()));
verify(rolesStore, never()).getRoleDescriptorsList(any(), any());
verify(rolesStore, never()).getRoleDescriptors(any(), any());
}
}
14 changes: 7 additions & 7 deletions .../src/test/java/org/elasticsearch/xpack/security/authz/store/CompositeRolesStoreTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2760,15 +2760,15 @@ public void testGetRoleDescriptorsListForInternalUsers() {
when(subject.getUser()).thenReturn(InternalUsers.SYSTEM_USER);
final IllegalArgumentException e1 = expectThrows(
IllegalArgumentException.class,
() -> compositeRolesStore.getRoleDescriptorsList(subject, new PlainActionFuture<>())
() -> compositeRolesStore.getRoleDescriptors(subject, ActionListener.noop())
);
assertThat(e1.getMessage(), equalTo("should never try to get the roles for internal user [" + SystemUser.NAME + "]"));

for (var internalUser : AuthenticationTestHelper.internalUsersWithLocalRoleDescriptor()) {
when(subject.getUser()).thenReturn(internalUser);
final PlainActionFuture<Collection<Set<RoleDescriptor>>> future = new PlainActionFuture<>();
compositeRolesStore.getRoleDescriptorsList(subject, future);
assertThat(future.actionGet(), equalTo(List.of(Set.of(internalUser.getLocalClusterRoleDescriptor().get()))));
final PlainActionFuture<Set<RoleDescriptor>> future = new PlainActionFuture<>();
compositeRolesStore.getRoleDescriptors(subject, future);
assertThat(future.actionGet(), equalTo(Set.of(internalUser.getLocalClusterRoleDescriptor().get())));
}
}

Expand All @@ -2787,9 +2787,9 @@ public void testGetRoleDescriptorsListUsesRoleStoreToResolveRoleWithInternalRole
when(subject.getRoleReferenceIntersection(any())).thenReturn(
new RoleReferenceIntersection(new RoleReference.NamedRoleReference(new String[] { roleName }))
);
final PlainActionFuture<Collection<Set<RoleDescriptor>>> future = new PlainActionFuture<>();
compositeRolesStore.getRoleDescriptorsList(subject, future);
assertThat(future.actionGet(), equalTo(List.of(Set.of(expectedRoleDescriptor))));
final PlainActionFuture<Set<RoleDescriptor>> future = new PlainActionFuture<>();
compositeRolesStore.getRoleDescriptors(subject, future);
assertThat(future.actionGet(), equalTo(Set.of(expectedRoleDescriptor)));
}

private void getRoleForRoleNames(CompositeRolesStore rolesStore, Collection<String> roleNames, ActionListener<Role> listener) {
Expand Down