Skip to content

Bugfix: Prevent invalid privileges in manage roles privilege #128532

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

Merged
merged 14 commits into from
May 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions docs/changelog/128532.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
pr: 128532
summary: "Prevent invalid privileges in manage roles privilege"
area: "Authorization"
type: bug
issues: [127496]
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,11 @@ public static ManageRolesPrivilege parse(XContentParser parser) throws IOExcepti
}
for (String privilege : indexPrivilege.privileges) {
IndexPrivilege namedPrivilege = IndexPrivilege.getNamedOrNull(privilege);

// Use resolveBySelectorAccess to determine whether the passed privilege is valid.
// IllegalArgumentException is thrown here when an invalid permission is encountered.
IndexPrivilege.resolveBySelectorAccess(Set.of(privilege));

if (namedPrivilege != null && namedPrivilege.getSelectorPredicate() == IndexComponentSelectorPredicate.FAILURES) {
throw new IllegalArgumentException(
"Failure store related privileges are not supported as targets of manage roles but found [" + privilege + "]"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,13 @@

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.List;
import java.util.Locale;
import java.util.Objects;

import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.nullValue;
import static org.hamcrest.core.Is.is;
import static org.hamcrest.core.IsEqual.equalTo;
Expand Down Expand Up @@ -257,6 +260,70 @@ public void testPutRoleRequestContainsNonIndexPrivileges() {
assertThat(permissionCheck(permission, "cluster:admin/xpack/security/role/put", putRoleRequest), is(false));
}

public void testParseInvalidPrivilege() throws Exception {
final String unknownPrivilege = randomValueOtherThanMany(
i -> IndexPrivilege.values().containsKey(i),
() -> randomAlphaOfLength(10).toLowerCase(Locale.ROOT)
);

final String invalidJsonString = String.format(Locale.ROOT, """
{
"manage": {
"indices": [
{
"names": ["test-*"],
"privileges": ["%s"]
}
]
}
}""", unknownPrivilege);
assertInvalidPrivilegeParsing(invalidJsonString, unknownPrivilege);
}

public void testParseMixedValidAndInvalidPrivileges() throws Exception {
final String unknownPrivilege = randomValueOtherThanMany(
i -> IndexPrivilege.values().containsKey(i),
() -> randomAlphaOfLength(10).toLowerCase(Locale.ROOT)
);

final String validPrivilege = "read";
final String mixedPrivilegesJson = String.format(Locale.ROOT, """
{
"manage": {
"indices": [
{
"names": ["test-*"],
"privileges": ["%s", "%s"]
}
]
}
}""", validPrivilege, unknownPrivilege);

assertInvalidPrivilegeParsing(mixedPrivilegesJson, unknownPrivilege);
}

/**
* Helper method to assert that parsing the given JSON payload results in an
* IllegalArgumentException due to an unknown privilege.
*
* @param jsonPayload The JSON string containing the privilege data.
* @param expectedErrorDetail The specific unknown privilege name expected in the error message.
*/
private static void assertInvalidPrivilegeParsing(final String jsonPayload, final String expectedErrorDetail) throws Exception {
final XContent xContent = XContentType.JSON.xContent();

try (
XContentParser parser = xContent.createParser(XContentParserConfiguration.EMPTY, jsonPayload.getBytes(StandardCharsets.UTF_8))
) {
assertThat(parser.nextToken(), equalTo(XContentParser.Token.START_OBJECT));
assertThat(parser.nextToken(), equalTo(XContentParser.Token.FIELD_NAME));

IllegalArgumentException exception = expectThrows(IllegalArgumentException.class, () -> ManageRolesPrivilege.parse(parser));

assertThat(exception.getMessage(), containsString("unknown index privilege [" + expectedErrorDetail + "]"));
}
}

private static boolean permissionCheck(ClusterPermission permission, String action, ActionRequest request) {
final Authentication authentication = AuthenticationTestHelper.builder().build();
assertThat(request.validate(), nullValue());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.not;

public class BulkPutRoleRestIT extends SecurityOnTrialLicenseRestTestCase {
public class PutRoleRestIT extends SecurityOnTrialLicenseRestTestCase {
public void testPutManyValidRoles() throws Exception {
Map<String, Object> responseMap = upsertRoles("""
{"roles": {"test1": {"cluster": ["all"],"indices": [{"names": ["*"],"privileges": ["all"]}]}, "test2":
Expand Down Expand Up @@ -312,4 +312,40 @@ public void testBulkUpdates() throws Exception {
);
}
}

public void testPutRoleWithInvalidManageRolesPrivilege() throws Exception {
final String badRoleName = "bad-role";

final ResponseException exception = expectThrows(ResponseException.class, () -> upsertRoles(String.format("""
{
"roles": {
"%s": {
"global": {
"role": {
"manage": {
"indices": [
{
"names": ["allowed-index-prefix-*"],
"privileges": ["foobar"]
}
]
}
}
}
}
}
}""", badRoleName)));

assertThat(exception.getMessage(), containsString("unknown index privilege [foobar]"));
assertEquals(400, exception.getResponse().getStatusLine().getStatusCode());
assertRoleDoesNotExist(badRoleName);
}

private void assertRoleDoesNotExist(final String roleName) throws Exception {
final ResponseException roleNotFound = expectThrows(
ResponseException.class,
() -> adminClient().performRequest(new Request("GET", "/_security/role/" + roleName))
);
assertEquals(404, roleNotFound.getResponse().getStatusLine().getStatusCode());
}
}
Loading