Skip to content

Commit

Permalink
implement securetransportaction for get alerts and ack alerts and edg…
Browse files Browse the repository at this point in the history 
…e case secure IT tests (#161) (#210)

Signed-off-by: Raj Chakravarthi <[email protected]>
  • Loading branch information
@opensearch-trigger-bot
opensearch-trigger-bot[bot] authored Dec 24, 2022
1 parent 7df9be8 commit 3b490a1
Show file tree
Hide file tree
Showing 5 changed files with 161 additions and 15 deletions.
36 changes: 34 additions & 2 deletions ...ain/java/org/opensearch/securityanalytics/transport/TransportAcknowledgeAlertsAction.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,44 +7,72 @@
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.opensearch.OpenSearchException;
import org.opensearch.OpenSearchStatusException;
import org.opensearch.action.ActionListener;
import org.opensearch.action.StepListener;
import org.opensearch.action.support.ActionFilters;
import org.opensearch.action.support.HandledTransportAction;
import org.opensearch.client.Client;
import org.opensearch.cluster.service.ClusterService;
import org.opensearch.common.inject.Inject;
import org.opensearch.common.settings.Settings;
import org.opensearch.common.xcontent.NamedXContentRegistry;
import org.opensearch.commons.alerting.action.GetAlertsResponse;
import org.opensearch.commons.alerting.model.Table;
import org.opensearch.commons.authuser.User;
import org.opensearch.rest.RestStatus;
import org.opensearch.securityanalytics.action.AckAlertsRequest;
import org.opensearch.securityanalytics.action.AckAlertsResponse;
import org.opensearch.securityanalytics.action.AckAlertsAction;
import org.opensearch.securityanalytics.action.GetDetectorRequest;
import org.opensearch.securityanalytics.action.GetDetectorResponse;
import org.opensearch.securityanalytics.alerts.AlertsService;
import org.opensearch.securityanalytics.model.Detector;
import org.opensearch.securityanalytics.settings.SecurityAnalyticsSettings;
import org.opensearch.tasks.Task;
import org.opensearch.threadpool.ThreadPool;
import org.opensearch.transport.TransportService;

public class TransportAcknowledgeAlertsAction extends HandledTransportAction<AckAlertsRequest, AckAlertsResponse> {
public class TransportAcknowledgeAlertsAction extends HandledTransportAction<AckAlertsRequest, AckAlertsResponse> implements SecureTransportAction {
private final TransportGetDetectorAction transportGetDetectorAction;

private final NamedXContentRegistry xContentRegistry;

private final ClusterService clusterService;

private final Settings settings;

private final ThreadPool threadPool;
private final AlertsService alertsService;

private volatile Boolean filterByEnabled;

private static final Logger log = LogManager.getLogger(TransportAcknowledgeAlertsAction.class);

@Inject
public TransportAcknowledgeAlertsAction(TransportService transportService, ActionFilters actionFilters, TransportGetDetectorAction transportGetDetectorAction, NamedXContentRegistry xContentRegistry, Client client) {
public TransportAcknowledgeAlertsAction(TransportService transportService, ActionFilters actionFilters, ClusterService clusterService, ThreadPool threadPool, Settings settings, TransportGetDetectorAction transportGetDetectorAction, NamedXContentRegistry xContentRegistry, Client client) {
super(AckAlertsAction.NAME, transportService, actionFilters, AckAlertsRequest::new);
this.transportGetDetectorAction = transportGetDetectorAction;
this.xContentRegistry = xContentRegistry;
this.clusterService = clusterService;
this.threadPool = threadPool;
this.settings = settings;
this.filterByEnabled = SecurityAnalyticsSettings.FILTER_BY_BACKEND_ROLES.get(this.settings);
this.alertsService = new AlertsService(client);
this.clusterService.getClusterSettings().addSettingsUpdateConsumer(SecurityAnalyticsSettings.FILTER_BY_BACKEND_ROLES, this::setFilterByEnabled);
}

@Override
protected void doExecute(Task task, AckAlertsRequest request, ActionListener<AckAlertsResponse> actionListener) {

User user = readUserFromThreadContext(this.threadPool);

String validateBackendRoleMessage = validateUserBackendRoles(user, this.filterByEnabled);
if (!"".equals(validateBackendRoleMessage)) {
actionListener.onFailure(new OpenSearchStatusException("Do not have permissions to resource", RestStatus.FORBIDDEN));
return;
}

GetDetectorRequest getDetectorRequest = new GetDetectorRequest(request.getDetectorId(), -3L);
transportGetDetectorAction.doExecute(task, getDetectorRequest, new ActionListener<GetDetectorResponse>() {
@Override
Expand Down Expand Up @@ -76,4 +104,8 @@ private boolean isDetectorAlertsMonitorMismatch(Detector detector, GetAlertsResp
return getAlertsResponse.getAlerts().stream()
.anyMatch(alert -> false == detector.getMonitorIds().contains(alert.getMonitorId())) ;
}

private void setFilterByEnabled(boolean filterByEnabled) {
this.filterByEnabled = filterByEnabled;
}
}
34 changes: 32 additions & 2 deletions src/main/java/org/opensearch/securityanalytics/transport/TransportGetAlertsAction.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,11 @@
import org.opensearch.action.support.ActionFilters;
import org.opensearch.action.support.HandledTransportAction;
import org.opensearch.client.Client;
import org.opensearch.cluster.service.ClusterService;
import org.opensearch.common.inject.Inject;
import org.opensearch.common.settings.Settings;
import org.opensearch.common.xcontent.NamedXContentRegistry;
import org.opensearch.commons.authuser.User;
import org.opensearch.index.query.NestedQueryBuilder;
import org.opensearch.index.query.QueryBuilders;
import org.opensearch.rest.RestStatus;
Expand All @@ -29,34 +32,58 @@
import org.opensearch.securityanalytics.action.SearchDetectorRequest;
import org.opensearch.securityanalytics.alerts.AlertsService;
import org.opensearch.securityanalytics.model.Detector;
import org.opensearch.securityanalytics.settings.SecurityAnalyticsSettings;
import org.opensearch.securityanalytics.util.DetectorUtils;
import org.opensearch.securityanalytics.util.SecurityAnalyticsException;
import org.opensearch.tasks.Task;
import org.opensearch.threadpool.ThreadPool;
import org.opensearch.transport.TransportService;

import static org.opensearch.securityanalytics.util.DetectorUtils.DETECTOR_TYPE_PATH;

public class TransportGetAlertsAction extends HandledTransportAction<GetAlertsRequest, GetAlertsResponse> {
public class TransportGetAlertsAction extends HandledTransportAction<GetAlertsRequest, GetAlertsResponse> implements SecureTransportAction {

private final TransportSearchDetectorAction transportSearchDetectorAction;

private final NamedXContentRegistry xContentRegistry;

private final ClusterService clusterService;

private final Settings settings;

private final ThreadPool threadPool;

private final AlertsService alertsService;

private volatile Boolean filterByEnabled;

private static final Logger log = LogManager.getLogger(TransportGetAlertsAction.class);


@Inject
public TransportGetAlertsAction(TransportService transportService, ActionFilters actionFilters, TransportSearchDetectorAction transportSearchDetectorAction, NamedXContentRegistry xContentRegistry, Client client) {
public TransportGetAlertsAction(TransportService transportService, ActionFilters actionFilters, ClusterService clusterService, TransportSearchDetectorAction transportSearchDetectorAction, ThreadPool threadPool, Settings settings, NamedXContentRegistry xContentRegistry, Client client) {
super(GetAlertsAction.NAME, transportService, actionFilters, GetAlertsRequest::new);
this.transportSearchDetectorAction = transportSearchDetectorAction;
this.xContentRegistry = xContentRegistry;
this.alertsService = new AlertsService(client);
this.clusterService = clusterService;
this.threadPool = threadPool;
this.settings = settings;
this.filterByEnabled = SecurityAnalyticsSettings.FILTER_BY_BACKEND_ROLES.get(this.settings);
this.clusterService.getClusterSettings().addSettingsUpdateConsumer(SecurityAnalyticsSettings.FILTER_BY_BACKEND_ROLES, this::setFilterByEnabled);
}

@Override
protected void doExecute(Task task, GetAlertsRequest request, ActionListener<GetAlertsResponse> actionListener) {

User user = readUserFromThreadContext(this.threadPool);

String validateBackendRoleMessage = validateUserBackendRoles(user, this.filterByEnabled);
if (!"".equals(validateBackendRoleMessage)) {
actionListener.onFailure(new OpenSearchStatusException("Do not have permissions to resource", RestStatus.FORBIDDEN));
return;
}

if (request.getDetectorType() == null) {
alertsService.getAlertsByDetectorId(
request.getDetectorId(),
Expand Down Expand Up @@ -122,4 +149,7 @@ public void onFailure(Exception e) {
}
}

private void setFilterByEnabled(boolean filterByEnabled) {
this.filterByEnabled = filterByEnabled;
}
}
32 changes: 28 additions & 4 deletions src/test/java/org/opensearch/securityanalytics/alerts/SecureAlertsRestApiIT.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ public class SecureAlertsRestApiIT extends SecurityAnalyticsRestTestCase {
static String TEST_HR_BACKEND_ROLE = "HR";
static String TEST_IT_BACKEND_ROLE = "IT";
private final String user = "userAlert";
private static final String[] EMPTY_ARRAY = new String[0];
private RestClient userClient;

@Before
Expand Down Expand Up @@ -185,9 +186,21 @@ public void testGetAlerts_byDetectorId_success() throws IOException {
getAlertsResponse = makeRequest(userReadOnlyClient, "GET", SecurityAnalyticsPlugin.ALERTS_BASE_URI, params, null);
getAlertsBody = asMap(getAlertsResponse);
Assert.assertEquals(1, getAlertsBody.get("total_alerts"));

userReadOnlyClient.close();
deleteUser(userRead);

// update user with no backend roles and try again
createUser(userRead, userRead, EMPTY_ARRAY);
userReadOnlyClient = new SecureRestClientBuilder(getClusterHosts().toArray(new HttpHost[]{}), isHttps(), userRead, userRead).setSocketTimeout(60000).build();
try {
getAlertsResponse = makeRequest(userReadOnlyClient, "GET", SecurityAnalyticsPlugin.ALERTS_BASE_URI, params, null);
} catch (ResponseException e)
{
assertEquals("Get alert failed", RestStatus.FORBIDDEN, restStatus(e.getResponse()));
}
finally {
userReadOnlyClient.close();
deleteUser(userRead);
}
}


Expand Down Expand Up @@ -282,10 +295,21 @@ public void testGetAlerts_byDetectorType_success() throws IOException, Interrupt
getAlertsResponse = makeRequest(userReadOnlyClient, "GET", SecurityAnalyticsPlugin.ALERTS_BASE_URI, params, null);
getAlertsBody = asMap(getAlertsResponse);
Assert.assertEquals(1, getAlertsBody.get("total_alerts"));

userReadOnlyClient.close();
deleteUser(userRead);

// update user with no backend roles and try again
createUser(userRead, userRead, EMPTY_ARRAY);
userReadOnlyClient = new SecureRestClientBuilder(getClusterHosts().toArray(new HttpHost[]{}), isHttps(), userRead, userRead).setSocketTimeout(60000).build();
try {
getAlertsResponse = makeRequest(userReadOnlyClient, "GET", SecurityAnalyticsPlugin.ALERTS_BASE_URI, params, null);
} catch (ResponseException e)
{
assertEquals("Get alert failed", RestStatus.FORBIDDEN, restStatus(e.getResponse()));
}
finally {
userReadOnlyClient.close();
deleteUser(userRead);
}
}

}
34 changes: 30 additions & 4 deletions src/test/java/org/opensearch/securityanalytics/findings/SecureFindingRestApiIT.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ public class SecureFindingRestApiIT extends SecurityAnalyticsRestTestCase {
static String TEST_HR_BACKEND_ROLE = "HR";
static String TEST_IT_BACKEND_ROLE = "IT";
private final String user = "userFinding";
private static final String[] EMPTY_ARRAY = new String[0];
private RestClient userClient;


Expand Down Expand Up @@ -141,9 +142,21 @@ public void testGetFindings_byDetectorId_success() throws IOException {
getFindingsResponse = makeRequest(userReadOnlyClient, "GET", SecurityAnalyticsPlugin.FINDINGS_BASE_URI + "/_search", params, null);
getFindingsBody = entityAsMap(getFindingsResponse);
Assert.assertEquals(1, getFindingsBody.get("total_findings"));

userReadOnlyClient.close();
deleteUser(userRead);

// update user with no backend roles and try again
createUser(userRead, userRead, EMPTY_ARRAY);
userReadOnlyClient = new SecureRestClientBuilder(getClusterHosts().toArray(new HttpHost[]{}), isHttps(), userRead, userRead).setSocketTimeout(60000).build();
try {
getFindingsResponse = makeRequest(userReadOnlyClient, "GET", SecurityAnalyticsPlugin.FINDINGS_BASE_URI + "/_search", params, null);
} catch (ResponseException e)
{
assertEquals("Get finding failed", RestStatus.FORBIDDEN, restStatus(e.getResponse()));
}
finally {
userReadOnlyClient.close();
deleteUser(userRead);
}

}

Expand Down Expand Up @@ -280,8 +293,21 @@ public void testGetFindings_byDetectorType_success() throws IOException {
getFindingsResponse = makeRequest(userReadOnlyClient, "GET", SecurityAnalyticsPlugin.FINDINGS_BASE_URI + "/_search", params, null);
getFindingsBody = entityAsMap(getFindingsResponse);
Assert.assertEquals(1, getFindingsBody.get("total_findings"));

userReadOnlyClient.close();
deleteUser(userRead);


// update user with no backend roles and try again
createUser(userRead, userRead, EMPTY_ARRAY);
userReadOnlyClient = new SecureRestClientBuilder(getClusterHosts().toArray(new HttpHost[]{}), isHttps(), userRead, userRead).setSocketTimeout(60000).build();
try {
getFindingsResponse = makeRequest(userReadOnlyClient, "GET", SecurityAnalyticsPlugin.FINDINGS_BASE_URI + "/_search", params, null);
} catch (ResponseException e)
{
assertEquals("Get finding failed", RestStatus.FORBIDDEN, restStatus(e.getResponse()));
}
finally {
userReadOnlyClient.close();
deleteUser(userRead);
}
}
}
40 changes: 37 additions & 3 deletions src/test/java/org/opensearch/securityanalytics/resthandler/SecureDetectorRestApiIT.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,10 +155,7 @@ public void testCreateDetectorWithFullAccess() throws IOException {
Assert.assertEquals(createdId, getResponseBody.get("_id"));

//Search on id should give one result

String queryJson = "{ \"query\": { \"match\": { \"_id\" : \"" + createdId + "\"} } }";
// String queryJson = "{ \"query\": { \"match_all\": { } } }";
//
HttpEntity requestEntity = new NStringEntity(queryJson, ContentType.APPLICATION_JSON);
Response searchResponse = makeRequest(userReadOnlyClient, "POST", SecurityAnalyticsPlugin.DETECTOR_BASE_URI + "/" + "_search", Collections.emptyMap(), requestEntity);
Map<String, Object> searchResponseBody = asMap(searchResponse);
Expand All @@ -170,4 +167,41 @@ public void testCreateDetectorWithFullAccess() throws IOException {
userReadOnlyClient.close();
deleteUser(userRead);
}

public void testCreateDetectorWithNoBackendRoles() throws IOException {
// try to do create detector as a user with no backend roles
String userFull= "userFull";
String[] backendRoles = {};
createUserWithData( userFull, userFull, SECURITY_ANALYTICS_FULL_ACCESS_ROLE, backendRoles );
RestClient userFullClient = new SecureRestClientBuilder(getClusterHosts().toArray(new HttpHost[]{}), isHttps(), userFull, userFull).setSocketTimeout(60000).build();

String index = createTestIndex(client(), randomIndex(), windowsIndexMapping(), Settings.EMPTY);

// Execute CreateMappingsAction to add alias mapping for index
Request createMappingRequest = new Request("POST", SecurityAnalyticsPlugin.MAPPER_BASE_URI);
// both req params and req body are supported
createMappingRequest.setJsonEntity(
"{ \"index_name\":\"" + index + "\"," +
" \"rule_topic\":\"" + randomDetectorType() + "\", " +
" \"partial\":true" +
"}"
);

Response response = userFullClient.performRequest(createMappingRequest);
assertEquals(HttpStatus.SC_OK, response.getStatusLine().getStatusCode());

Detector detector = randomDetector(getRandomPrePackagedRules());
// Enable backend filtering and try to read detector as a user with no backend roles matching the user who created the detector
enableOrDisableFilterBy("true");
try {
Response createResponse = makeRequest(userFullClient, "POST", SecurityAnalyticsPlugin.DETECTOR_BASE_URI, Collections.emptyMap(), toHttpEntity(detector));
} catch (ResponseException e)
{
assertEquals("Create detector failed", RestStatus.FORBIDDEN, restStatus(e.getResponse()));
}
finally {
userFullClient.close();
deleteUser(userFull);
}
}
}

0 comments on commit 3b490a1

Please sign in to comment.