Skip to content

Update test/security/s* java files #2836

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
stephen-crawford merged 2 commits into from
Jun 5, 2023
Merged

Update test/security/s* java files #2836

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
5d28375
Update test/security/s* java files
stephen-crawford Jun 5, 2023
289d030
Update test/security/s* java files
stephen-crawford Jun 5, 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
2 changes: 2 additions & 0 deletions build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ spotless {
target '**/test/java/org/opensearch/security/f*/**/*.java'
target '**/test/java/org/opensearch/security/h*/**/*.java'
target '**/test/java/org/opensearch/security/m*/**/*.java'
target '**/test/java/org/opensearch/security/s*/**/*.java'

removeUnusedImports()
eclipse().configFile rootProject.file('formatter/formatterConfig.xml')
Expand Down Expand Up @@ -125,6 +126,7 @@ spotless {
targetExclude '**/test/java/org/opensearch/security/f*/**/*.java'
targetExclude '**/test/java/org/opensearch/security/h*/**/*.java'
targetExclude '**/test/java/org/opensearch/security/m*/**/*.java'
targetExclude '**/test/java/org/opensearch/security/s*/**/*.java'
targetExclude 'src/integrationTest/**'

trimTrailingWhitespace()
Expand Down
46 changes: 22 additions & 24 deletions src/test/java/org/opensearch/security/sanity/tests/SecurityRestTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,54 +45,52 @@
public class SecurityRestTestCase extends OpenSearchRestTestCase {

private static final String CERT_FILE_DIRECTORY = "sanity-tests/";

private boolean isHttps() {
return System.getProperty("https").equals("true");
}

private boolean securityEnabled() {
return System.getProperty("security.enabled").equals("true");
}

@Override
protected Settings restAdminSettings(){
return Settings
.builder()
.put("http.port", 9200)
.put(SECURITY_SSL_HTTP_ENABLED, isHttps())
.put(SECURITY_SSL_HTTP_PEMCERT_FILEPATH, CERT_FILE_DIRECTORY + "opensearch-node.pem")
.put(SECURITY_SSL_HTTP_PEMKEY_FILEPATH, CERT_FILE_DIRECTORY + "opensearch-node-key.pem")
.put(SECURITY_SSL_HTTP_PEMTRUSTEDCAS_FILEPATH, CERT_FILE_DIRECTORY + "root-ca.pem")
.put(SECURITY_SSL_HTTP_KEYSTORE_FILEPATH, CERT_FILE_DIRECTORY + "test-kirk.jks")
.put(SECURITY_SSL_HTTP_KEYSTORE_PASSWORD.insecurePropertyName, "changeit")
.put(SECURITY_SSL_HTTP_KEYSTORE_KEYPASSWORD.insecurePropertyName, "changeit")
.build();
protected Settings restAdminSettings() {
return Settings.builder()
.put("http.port", 9200)
.put(SECURITY_SSL_HTTP_ENABLED, isHttps())
.put(SECURITY_SSL_HTTP_PEMCERT_FILEPATH, CERT_FILE_DIRECTORY + "opensearch-node.pem")
.put(SECURITY_SSL_HTTP_PEMKEY_FILEPATH, CERT_FILE_DIRECTORY + "opensearch-node-key.pem")
.put(SECURITY_SSL_HTTP_PEMTRUSTEDCAS_FILEPATH, CERT_FILE_DIRECTORY + "root-ca.pem")
.put(SECURITY_SSL_HTTP_KEYSTORE_FILEPATH, CERT_FILE_DIRECTORY + "test-kirk.jks")
.put(SECURITY_SSL_HTTP_KEYSTORE_PASSWORD.insecurePropertyName, "changeit")
.put(SECURITY_SSL_HTTP_KEYSTORE_KEYPASSWORD.insecurePropertyName, "changeit")
.build();
}

@Override
protected RestClient buildClient(Settings settings, HttpHost[] hosts) throws IOException {

if(securityEnabled()){
if (securityEnabled()) {
String keystore = settings.get(SECURITY_SSL_HTTP_KEYSTORE_FILEPATH);

if(keystore != null){
if (keystore != null) {
// create adminDN (super-admin) client
File file = new File(getClass().getClassLoader().getResource(CERT_FILE_DIRECTORY).getFile());
Path configPath = PathUtils.get(file.toURI()).getParent().toAbsolutePath();
return new SecureRestClientBuilder(settings, configPath)
.setSocketTimeout(60000)
.setConnectionRequestTimeout(180000)
.build();
return new SecureRestClientBuilder(settings, configPath).setSocketTimeout(60000)
.setConnectionRequestTimeout(180000)
.build();
}

// create client with passed user
String userName = System.getProperty("user");
String password = System.getProperty("password");

return new SecureRestClientBuilder(hosts, isHttps(), userName, password)
.setSocketTimeout(60000)
.setConnectionRequestTimeout(180000)
.build();
}
else {
return new SecureRestClientBuilder(hosts, isHttps(), userName, password).setSocketTimeout(60000)
.setConnectionRequestTimeout(180000)
.build();
} else {
RestClientBuilder builder = RestClient.builder(hosts);
configureClient(builder, settings);
builder.setStrictDeprecationMode(true);
Expand Down
1 change: 0 additions & 1 deletion src/test/java/org/opensearch/security/sanity/tests/SingleClusterSanityIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.not;


@SuppressWarnings("unchecked")
public class SingleClusterSanityIT extends SecurityRestTestCase {

Expand Down
182 changes: 78 additions & 104 deletions src/test/java/org/opensearch/security/securityconf/SecurityRolesPermissionsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,90 +56,62 @@

public class SecurityRolesPermissionsTest {

static final Map<String, ObjectNode> NO_REST_ADMIN_PERMISSIONS_ROLES =
ImmutableMap.<String, ObjectNode>builder()
.put(
"all_access",
role("*"))
.put(
"all_cluster_and_indices",
role("custer:*", "indices:*")
).build();

static final Map<String, ObjectNode> REST_ADMIN_PERMISSIONS_FULL_ACCESS_ROLES =
ImmutableMap.<String, ObjectNode>builder()
.put(
"security_rest_api_full_access",
role(allRestApiPermissions()))
.put(
"security_rest_api_full_access_with_star",
role("restapi:admin/*"))
.build();
static final Map<String, ObjectNode> NO_REST_ADMIN_PERMISSIONS_ROLES = ImmutableMap.<String, ObjectNode>builder()
.put("all_access", role("*"))
.put("all_cluster_and_indices", role("custer:*", "indices:*"))
.build();

static final Map<String, ObjectNode> REST_ADMIN_PERMISSIONS_FULL_ACCESS_ROLES = ImmutableMap.<String, ObjectNode>builder()
.put("security_rest_api_full_access", role(allRestApiPermissions()))
.put("security_rest_api_full_access_with_star", role("restapi:admin/*"))
.build();

static String restAdminApiRoleName(final String endpoint) {
return String.format("security_rest_api_%s_only", endpoint);
}

static final Map<String, ObjectNode> REST_ADMIN_PERMISSIONS_ROLES =
ENDPOINTS_WITH_PERMISSIONS
.entrySet()
.stream()
.flatMap(e -> {
final String endpoint = e.getKey().name().toLowerCase(Locale.ROOT);
final PermissionBuilder pb = e.getValue();
if (e.getKey() == Endpoint.SSL) {
return Stream.of(
new SimpleEntry<>(
restAdminApiRoleName(CERTS_INFO_ACTION),
role(pb.build(CERTS_INFO_ACTION))
),
new SimpleEntry<>(
restAdminApiRoleName(RELOAD_CERTS_ACTION),
role(pb.build(RELOAD_CERTS_ACTION))
)
);
} else {
return Stream.of(
new SimpleEntry<>(restAdminApiRoleName(endpoint), role(pb.build()))
);
}
}).collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
static final Map<String, ObjectNode> REST_ADMIN_PERMISSIONS_ROLES = ENDPOINTS_WITH_PERMISSIONS.entrySet().stream().flatMap(e -> {
final String endpoint = e.getKey().name().toLowerCase(Locale.ROOT);
final PermissionBuilder pb = e.getValue();
if (e.getKey() == Endpoint.SSL) {
return Stream.of(
new SimpleEntry<>(restAdminApiRoleName(CERTS_INFO_ACTION), role(pb.build(CERTS_INFO_ACTION))),
new SimpleEntry<>(restAdminApiRoleName(RELOAD_CERTS_ACTION), role(pb.build(RELOAD_CERTS_ACTION)))
);
} else {
return Stream.of(new SimpleEntry<>(restAdminApiRoleName(endpoint), role(pb.build())));
}
}).collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));

static ObjectNode role(final String... clusterPermissions) {
final ArrayNode clusterPermissionsArrayNode = DefaultObjectMapper.objectMapper.createArrayNode();
Arrays.stream(clusterPermissions).forEach(clusterPermissionsArrayNode::add);
return DefaultObjectMapper.objectMapper
.createObjectNode()
.put("reserved", true)
.set("cluster_permissions", clusterPermissionsArrayNode);
return DefaultObjectMapper.objectMapper.createObjectNode()
.put("reserved", true)
.set("cluster_permissions", clusterPermissionsArrayNode);
}

static String[] allRestApiPermissions() {
return ENDPOINTS_WITH_PERMISSIONS
.entrySet()
.stream()
.flatMap(entry -> {
if (entry.getKey() == Endpoint.SSL) {
return Stream.of(entry.getValue().build(CERTS_INFO_ACTION), entry.getValue().build(RELOAD_CERTS_ACTION));
} else {
return Stream.of(entry.getValue().build());
}
}).toArray(String[]::new);
return ENDPOINTS_WITH_PERMISSIONS.entrySet().stream().flatMap(entry -> {
if (entry.getKey() == Endpoint.SSL) {
return Stream.of(entry.getValue().build(CERTS_INFO_ACTION), entry.getValue().build(RELOAD_CERTS_ACTION));
} else {
return Stream.of(entry.getValue().build());
}
}).toArray(String[]::new);
}

final ConfigModel configModel;

public SecurityRolesPermissionsTest() throws IOException {
this.configModel =
new ConfigModelV7(
createRolesConfig(),
createRoleMappingsConfig(),
createActionGroupsConfig(),
createTenantsConfig(),
Mockito.mock(DynamicConfigModel.class),
Settings.EMPTY
);
this.configModel = new ConfigModelV7(
createRolesConfig(),
createRoleMappingsConfig(),
createActionGroupsConfig(),
createTenantsConfig(),
Mockito.mock(DynamicConfigModel.class),
Settings.EMPTY
);
}

@Test
Expand All @@ -151,17 +123,17 @@ public void hasNoExplicitClusterPermissionPermissionForRestAdmin() {
final PermissionBuilder permissionBuilder = entry.getValue();
if (endpoint == Endpoint.SSL) {
Assert.assertFalse(
endpoint.name(),
securityRolesForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build(CERTS_INFO_ACTION))
endpoint.name(),
securityRolesForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build(CERTS_INFO_ACTION))
);
Assert.assertFalse(
endpoint.name(),
securityRolesForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build(RELOAD_CERTS_ACTION))
endpoint.name(),
securityRolesForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build(RELOAD_CERTS_ACTION))
);
} else {
Assert.assertFalse(
endpoint.name(),
securityRolesForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build())
endpoint.name(),
securityRolesForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build())
);
}
}
Expand All @@ -176,10 +148,19 @@ public void hasExplicitClusterPermissionPermissionForRestAdminWitFullAccess() {
final Endpoint endpoint = entry.getKey();
final PermissionBuilder permissionBuilder = entry.getValue();
if (endpoint == Endpoint.SSL) {
Assert.assertTrue(endpoint.name() + "/" + CERTS_INFO_ACTION, securityRolesForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build(CERTS_INFO_ACTION)));
Assert.assertTrue(endpoint.name() + "/" + CERTS_INFO_ACTION, securityRolesForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build(RELOAD_CERTS_ACTION)));
Assert.assertTrue(
endpoint.name() + "/" + CERTS_INFO_ACTION,
securityRolesForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build(CERTS_INFO_ACTION))
);
Assert.assertTrue(
endpoint.name() + "/" + CERTS_INFO_ACTION,
securityRolesForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build(RELOAD_CERTS_ACTION))
);
} else {
Assert.assertTrue(endpoint.name(), securityRolesForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build()));
Assert.assertTrue(
endpoint.name(),
securityRolesForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build())
);
}
}
}
Expand All @@ -188,60 +169,53 @@ public void hasExplicitClusterPermissionPermissionForRestAdminWitFullAccess() {
@Test
public void hasExplicitClusterPermissionPermissionForRestAdmin() {
// verify all endpoint except SSL
final Collection<Endpoint> noSslEndpoints =
ENDPOINTS_WITH_PERMISSIONS.keySet().stream()
.filter(e -> e != Endpoint.SSL).collect(Collectors.toList());
final Collection<Endpoint> noSslEndpoints = ENDPOINTS_WITH_PERMISSIONS.keySet()
.stream()
.filter(e -> e != Endpoint.SSL)
.collect(Collectors.toList());
for (final Endpoint endpoint : noSslEndpoints) {
final String permission = ENDPOINTS_WITH_PERMISSIONS.get(endpoint).build();
final SecurityRoles allowOnePermissionRole =
configModel.getSecurityRoles().filter(
ImmutableSet.of(restAdminApiRoleName(endpoint.name().toLowerCase(Locale.ROOT))));
final SecurityRoles allowOnePermissionRole = configModel.getSecurityRoles()
.filter(ImmutableSet.of(restAdminApiRoleName(endpoint.name().toLowerCase(Locale.ROOT))));
Assert.assertTrue(endpoint.name(), allowOnePermissionRole.hasExplicitClusterPermissionPermission(permission));
assertHasNoPermissionsForRestApiAdminOnePermissionRole(
endpoint,
allowOnePermissionRole
);
assertHasNoPermissionsForRestApiAdminOnePermissionRole(endpoint, allowOnePermissionRole);
}
// verify SSL endpoint with 2 actions
for (final String sslAction : ImmutableSet.of(CERTS_INFO_ACTION, RELOAD_CERTS_ACTION)) {
final SecurityRoles sslAllowRole =
configModel.getSecurityRoles().filter(ImmutableSet.of(restAdminApiRoleName(sslAction)));
final SecurityRoles sslAllowRole = configModel.getSecurityRoles().filter(ImmutableSet.of(restAdminApiRoleName(sslAction)));
final PermissionBuilder permissionBuilder = ENDPOINTS_WITH_PERMISSIONS.get(Endpoint.SSL);
Assert.assertTrue(
Endpoint.SSL + "/" + sslAction,
sslAllowRole.hasExplicitClusterPermissionPermission(permissionBuilder.build(sslAction))
Endpoint.SSL + "/" + sslAction,
sslAllowRole.hasExplicitClusterPermissionPermission(permissionBuilder.build(sslAction))
);
assertHasNoPermissionsForRestApiAdminOnePermissionRole(Endpoint.SSL, sslAllowRole);
}
}

void assertHasNoPermissionsForRestApiAdminOnePermissionRole(final Endpoint allowEndpoint, final SecurityRoles allowOnlyRoleForRole) {
final Collection<Endpoint> noPermissionEndpoints =
ENDPOINTS_WITH_PERMISSIONS.keySet().stream()
.filter(e -> e != allowEndpoint)
.collect(Collectors.toList());
final Collection<Endpoint> noPermissionEndpoints = ENDPOINTS_WITH_PERMISSIONS.keySet()
.stream()
.filter(e -> e != allowEndpoint)
.collect(Collectors.toList());
for (final Endpoint endpoint : noPermissionEndpoints) {
final PermissionBuilder permissionBuilder = ENDPOINTS_WITH_PERMISSIONS.get(endpoint);
if (endpoint == Endpoint.SSL) {
Assert.assertFalse(
endpoint.name(),
allowOnlyRoleForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build(CERTS_INFO_ACTION)));
endpoint.name(),
allowOnlyRoleForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build(CERTS_INFO_ACTION))
);
Assert.assertFalse(
endpoint.name(),
allowOnlyRoleForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build(RELOAD_CERTS_ACTION)));
endpoint.name(),
allowOnlyRoleForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build(RELOAD_CERTS_ACTION))
);
} else {
Assert.assertFalse(
endpoint.name(),
allowOnlyRoleForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build()));
Assert.assertFalse(endpoint.name(), allowOnlyRoleForRole.hasExplicitClusterPermissionPermission(permissionBuilder.build()));
}
}
}

static ObjectNode meta(final String type) {
return DefaultObjectMapper.objectMapper
.createObjectNode()
.put("type", type)
.put("config_version", 2);
return DefaultObjectMapper.objectMapper.createObjectNode().put("type", type).put("config_version", 2);
}

static <T> SecurityDynamicConfiguration<T> createRolesConfig() throws IOException {
Expand Down
Loading