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

Add validation for API key role descriptors #82049

Merged
merged 1 commit into from
Jan 10, 2022
Merged

Add validation for API key role descriptors #82049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion .../core/src/main/java/org/elasticsearch/xpack/core/security/action/CreateApiKeyRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.core.Nullable;
import org.elasticsearch.core.TimeValue;
import org.elasticsearch.xpack.core.security.action.role.RoleDescriptorRequestValidator;
import org.elasticsearch.xpack.core.security.authz.RoleDescriptor;
import org.elasticsearch.xpack.core.security.support.MetadataUtils;

Expand Down Expand Up @@ -159,10 +160,13 @@ public ActionRequestValidationException validate() {
}
if (metadata != null && MetadataUtils.containsReservedMetadata(metadata)) {
validationException = addValidationError(
"metadata keys may not start with [" + MetadataUtils.RESERVED_PREFIX + "]",
"API key metadata keys may not start with [" + MetadataUtils.RESERVED_PREFIX + "]",
validationException
);
}
for (RoleDescriptor roleDescriptor : roleDescriptors) {
validationException = RoleDescriptorRequestValidator.validate(roleDescriptor, validationException);
}
return validationException;
}

Expand Down
53 changes: 1 addition & 52 deletions .../core/src/main/java/org/elasticsearch/xpack/core/security/action/role/PutRoleRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,15 @@
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.core.Nullable;
import org.elasticsearch.xpack.core.security.authz.RoleDescriptor;
import org.elasticsearch.xpack.core.security.authz.privilege.ApplicationPrivilege;
import org.elasticsearch.xpack.core.security.authz.privilege.ClusterPrivilegeResolver;
import org.elasticsearch.xpack.core.security.authz.privilege.ConfigurableClusterPrivilege;
import org.elasticsearch.xpack.core.security.authz.privilege.ConfigurableClusterPrivileges;
import org.elasticsearch.xpack.core.security.authz.privilege.IndexPrivilege;
import org.elasticsearch.xpack.core.security.support.MetadataUtils;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static org.elasticsearch.action.ValidateActions.addValidationError;

/**
* Request object for adding a role to the security index
Expand Down Expand Up @@ -66,51 +59,7 @@ public PutRoleRequest() {}

@Override
public ActionRequestValidationException validate() {
ActionRequestValidationException validationException = null;
if (name == null) {
validationException = addValidationError("role name is missing", validationException);
}
if (clusterPrivileges != null) {
for (String cp : clusterPrivileges) {
try {
ClusterPrivilegeResolver.resolve(cp);
} catch (IllegalArgumentException ile) {
validationException = addValidationError(ile.getMessage(), validationException);
}
}
}
if (indicesPrivileges != null) {
for (RoleDescriptor.IndicesPrivileges idp : indicesPrivileges) {
try {
IndexPrivilege.get(Set.of(idp.getPrivileges()));
} catch (IllegalArgumentException ile) {
validationException = addValidationError(ile.getMessage(), validationException);
}
}
}
if (applicationPrivileges != null) {
for (RoleDescriptor.ApplicationResourcePrivileges privilege : applicationPrivileges) {
try {
ApplicationPrivilege.validateApplicationNameOrWildcard(privilege.getApplication());
} catch (IllegalArgumentException e) {
validationException = addValidationError(e.getMessage(), validationException);
}
for (String privilegeName : privilege.getPrivileges()) {
try {
ApplicationPrivilege.validatePrivilegeOrActionName(privilegeName);
} catch (IllegalArgumentException e) {
validationException = addValidationError(e.getMessage(), validationException);
}
}
}
}
if (metadata != null && MetadataUtils.containsReservedMetadata(metadata)) {
validationException = addValidationError(
"metadata keys may not start with [" + MetadataUtils.RESERVED_PREFIX + "]",
validationException
);
}
return validationException;
return RoleDescriptorRequestValidator.validate(roleDescriptor());
}

public void name(String name) {
Expand Down
78 changes: 78 additions & 0 deletions ...ava/org/elasticsearch/xpack/core/security/action/role/RoleDescriptorRequestValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

package org.elasticsearch.xpack.core.security.action.role;

import org.elasticsearch.action.ActionRequestValidationException;
import org.elasticsearch.xpack.core.security.authz.RoleDescriptor;
import org.elasticsearch.xpack.core.security.authz.privilege.ApplicationPrivilege;
import org.elasticsearch.xpack.core.security.authz.privilege.ClusterPrivilegeResolver;
import org.elasticsearch.xpack.core.security.authz.privilege.IndexPrivilege;
import org.elasticsearch.xpack.core.security.support.MetadataUtils;

import java.util.Set;

import static org.elasticsearch.action.ValidateActions.addValidationError;

public class RoleDescriptorRequestValidator {

private RoleDescriptorRequestValidator() {}

public static ActionRequestValidationException validate(RoleDescriptor roleDescriptor) {
return validate(roleDescriptor, null);
}

public static ActionRequestValidationException validate(
RoleDescriptor roleDescriptor,
ActionRequestValidationException validationException
) {
if (roleDescriptor.getName() == null) {
validationException = addValidationError("role name is missing", validationException);
}
if (roleDescriptor.getClusterPrivileges() != null) {
for (String cp : roleDescriptor.getClusterPrivileges()) {
try {
ClusterPrivilegeResolver.resolve(cp);
} catch (IllegalArgumentException ile) {
validationException = addValidationError(ile.getMessage(), validationException);
}
}
}
if (roleDescriptor.getIndicesPrivileges() != null) {
for (RoleDescriptor.IndicesPrivileges idp : roleDescriptor.getIndicesPrivileges()) {
try {
IndexPrivilege.get(Set.of(idp.getPrivileges()));
} catch (IllegalArgumentException ile) {
validationException = addValidationError(ile.getMessage(), validationException);
}
}
}
if (roleDescriptor.getApplicationPrivileges() != null) {
for (RoleDescriptor.ApplicationResourcePrivileges privilege : roleDescriptor.getApplicationPrivileges()) {
try {
ApplicationPrivilege.validateApplicationNameOrWildcard(privilege.getApplication());
} catch (IllegalArgumentException e) {
validationException = addValidationError(e.getMessage(), validationException);
}
for (String privilegeName : privilege.getPrivileges()) {
try {
ApplicationPrivilege.validatePrivilegeOrActionName(privilegeName);
} catch (IllegalArgumentException e) {
validationException = addValidationError(e.getMessage(), validationException);
}
}
}
}
if (roleDescriptor.getMetadata() != null && MetadataUtils.containsReservedMetadata(roleDescriptor.getMetadata())) {
validationException = addValidationError(
"role descriptor metadata keys may not start with [" + MetadataUtils.RESERVED_PREFIX + "]",
validationException
);
}
return validationException;
}
}
35 changes: 34 additions & 1 deletion .../src/test/java/org/elasticsearch/xpack/core/security/action/CreateApiKeyRequestTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import java.util.Map;

import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.containsStringIgnoringCase;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.is;

Expand Down Expand Up @@ -82,7 +83,39 @@ public void testMetadataKeyValidation() {
final ActionRequestValidationException ve = request.validate();
assertNotNull(ve);
assertThat(ve.validationErrors().size(), equalTo(1));
assertThat(ve.validationErrors().get(0), containsString("metadata keys may not start with [_]"));
assertThat(ve.validationErrors().get(0), containsString("API key metadata keys may not start with [_]"));
}

public void testRoleDescriptorValidation() {
final CreateApiKeyRequest request1 = new CreateApiKeyRequest(
randomAlphaOfLength(5),
List.of(
new RoleDescriptor(
randomAlphaOfLength(5),
new String[] { "manage_index_template" },
new RoleDescriptor.IndicesPrivileges[] {
RoleDescriptor.IndicesPrivileges.builder().indices("*").privileges("rad").build() },
new RoleDescriptor.ApplicationResourcePrivileges[] {
RoleDescriptor.ApplicationResourcePrivileges.builder()
.application(randomFrom("app*tab", "app 1"))
.privileges(randomFrom(" ", "\n"))
.resources("resource")
.build() },
null,
null,
Map.of("_key", "value"),
null
)
),
null
);
final ActionRequestValidationException ve1 = request1.validate();
assertNotNull(ve1);
assertThat(ve1.validationErrors().get(0), containsString("unknown cluster privilege"));
assertThat(ve1.validationErrors().get(1), containsString("unknown index privilege"));
assertThat(ve1.validationErrors().get(2), containsStringIgnoringCase("application name"));
assertThat(ve1.validationErrors().get(3), containsStringIgnoringCase("Application privilege names"));
assertThat(ve1.validationErrors().get(4), containsStringIgnoringCase("role descriptor metadata keys may not start with "));
}

public void testSerialization() throws IOException {
Expand Down