Skip to content

fix correlation engine trigger even if no rules are present #1545

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
merged 5 commits into from
Jun 20, 2025
Merged

fix correlation engine trigger even if no rules are present #1545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ef797f1
fix correlation engine trigger even if no rules are present
sbcd90 Jun 10, 2025
8dbc604
remove index pattern related tests and add test to verify correlation…
eirsep Jun 20, 2025
bb77c42
check and short circuit correlation evaluation if no rules and no aut…
eirsep Jun 20, 2025
225bb83
Revert "check and short circuit correlation evaluation if no rules an…
eirsep Jun 20, 2025
98dbf31
remove non-empty correlation index check
eirsep Jun 20, 2025
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
12 changes: 10 additions & 2 deletions src/main/java/org/opensearch/securityanalytics/correlation/JoinEngine.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,12 +253,20 @@ private void onAutoCorrelations(Detector detector, Finding finding, Map<String,
CorrelationRule rule = CorrelationRule.parse(xcp, hit.getId(), hit.getVersion());
correlationRules.add(rule);
}
getValidDocuments(detectorType, indices, correlationRules, relatedDocIds, autoCorrelations);
if (!correlationRules.isEmpty() || !autoCorrelations.isEmpty()) {
getValidDocuments(detectorType, indices, correlationRules, relatedDocIds, autoCorrelations);
} else {
correlateFindingAction.onOperation();
}
}, e -> {
try {
log.error("[CORRELATIONS] Exception encountered while searching correlation rule index for finding id {}",
finding.getId(), e);
getValidDocuments(detectorType, indices, List.of(), List.of(), autoCorrelations);
if (!autoCorrelations.isEmpty()) {
getValidDocuments(detectorType, indices, List.of(), List.of(), autoCorrelations);
} else {
correlateFindingAction.onOperation();
}
} catch (Exception ex) {
onFailure(ex);
}
Expand Down
7 changes: 6 additions & 1 deletion ...main/java/org/opensearch/securityanalytics/transport/TransportCorrelateFindingAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
import org.opensearch.securityanalytics.correlation.alert.CorrelationAlertService;
import org.opensearch.securityanalytics.correlation.alert.notifications.NotificationService;
import org.opensearch.securityanalytics.logtype.LogTypeService;
import org.opensearch.securityanalytics.model.CorrelationRule;
import org.opensearch.securityanalytics.model.CustomLogType;
import org.opensearch.securityanalytics.model.Detector;
import org.opensearch.securityanalytics.settings.SecurityAnalyticsSettings;
Expand Down Expand Up @@ -137,7 +138,11 @@ protected void doExecute(Task task, ActionRequest request, ActionListener<Subscr
try {
PublishFindingsRequest transformedRequest = transformRequest(request);
AsyncCorrelateFindingAction correlateFindingAction = new AsyncCorrelateFindingAction(task, transformedRequest, readUserFromThreadContext(this.threadPool), actionListener);

if (false == enableAutoCorrelation && false == clusterService.state().getRoutingTable().hasIndex(CorrelationRule.CORRELATION_RULE_INDEX)) {
log.debug("auto correlations is disabled and correlation rules index does not exist, skipping correlations");
correlateFindingAction.onOperation();
return;
}
if (!this.correlationIndices.correlationIndexExists()) {
try {
this.correlationIndices.initCorrelationIndex(ActionListener.wrap(response -> {
Expand Down
75 changes: 35 additions & 40 deletions src/test/java/org/opensearch/securityanalytics/correlation/CorrelationEngineRestApiIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,6 @@ public void testListCorrelationsWorkflow() throws IOException, InterruptedExcept

@SuppressWarnings("unchecked")
public void testBasicCorrelationEngineWorkflowWithoutRules() throws IOException, InterruptedException {
updateClusterSetting(SecurityAnalyticsSettings.ENABLE_AUTO_CORRELATIONS.getKey(), "true");
LogIndices indices = createIndices();

String vpcFlowMonitorId = createVpcFlowDetector(indices.vpcFlowsIndex);
Expand Down Expand Up @@ -220,7 +219,8 @@ public void testBasicCorrelationEngineWorkflowWithoutRules() throws IOException,
}
return false;
} catch (Exception ex) {
return false;
// because no findings are found
return true;
}
},
2, TimeUnit.MINUTES
Expand Down Expand Up @@ -679,66 +679,61 @@ public void testBasicCorrelationEngineWorkflowWithFieldBasedRulesOnMultipleLogTy
);
}

public void testBasicCorrelationEngineWorkflowWithIndexPatterns() throws IOException, InterruptedException {
@SuppressWarnings("unchecked")
public void testBasicCorrelationEngineWorkflowWithoutRulesAndWithoutAutoCorrelations() throws IOException, InterruptedException {
updateClusterSetting(SecurityAnalyticsSettings.ENABLE_AUTO_CORRELATIONS.getKey(), "false");

LogIndices indices = new LogIndices();
createTestIndex("windows1", windowsIndexMapping());
createTestIndex("windows2", windowsIndexMapping());
indices.windowsIndex = "windows*";
createTestIndex("vpc_flow1", vpcFlowMappings());
createTestIndex("vpc_flow2", vpcFlowMappings());
indices.vpcFlowsIndex = "vpc_flow*";
LogIndices indices = createIndices();

String vpcFlowMonitorId = createVpcFlowDetector(indices.vpcFlowsIndex);
String adLdapMonitorId = createAdLdapDetector(indices.adLdapLogsIndex);
String testWindowsMonitorId = createTestWindowsDetector(indices.windowsIndex);
String appLogsMonitorId = createAppLogsDetector(indices.appLogsIndex);
String s3MonitorId = createS3Detector(indices.s3AccessLogsIndex);

String ruleId = createNetworkToWindowsFilterQueryBasedRule(indices);

indexDoc("windows2", "2", randomDoc());
Response executeResponse = executeAlertingMonitor(testWindowsMonitorId, Collections.emptyMap());
indexDoc(indices.adLdapLogsIndex, "22", randomAdLdapDoc());
Response executeResponse = executeAlertingMonitor(adLdapMonitorId, Collections.emptyMap());
Map<String, Object> executeResults = entityAsMap(executeResponse);
int noOfSigmaRuleMatches = ((List<Map<String, Object>>) ((Map<String, Object>) executeResults.get("input_results")).get("results")).get(0).size();
Assert.assertEquals(1, noOfSigmaRuleMatches);

indexDoc(indices.windowsIndex, "2", randomDoc());
executeResponse = executeAlertingMonitor(testWindowsMonitorId, Collections.emptyMap());
executeResults = entityAsMap(executeResponse);
noOfSigmaRuleMatches = ((List<Map<String, Object>>) ((Map<String, Object>) executeResults.get("input_results")).get("results")).get(0).size();
Assert.assertEquals(5, noOfSigmaRuleMatches);

indexDoc("vpc_flow1", "1", randomVpcFlowDoc());
indexDoc(indices.appLogsIndex, "4", randomAppLogDoc());
executeResponse = executeAlertingMonitor(appLogsMonitorId, Collections.emptyMap());
executeResults = entityAsMap(executeResponse);
noOfSigmaRuleMatches = ((List<Map<String, Object>>) ((Map<String, Object>) executeResults.get("input_results")).get("results")).get(0).size();
Assert.assertEquals(0, noOfSigmaRuleMatches);

indexDoc(indices.s3AccessLogsIndex, "5", randomS3AccessLogDoc());
executeResponse = executeAlertingMonitor(s3MonitorId, Collections.emptyMap());
executeResults = entityAsMap(executeResponse);
noOfSigmaRuleMatches = ((List<Map<String, Object>>) ((Map<String, Object>) executeResults.get("input_results")).get("results")).get(0).size();
Assert.assertEquals(0, noOfSigmaRuleMatches);

indexDoc(indices.vpcFlowsIndex, "1", randomVpcFlowDoc());
executeResponse = executeAlertingMonitor(vpcFlowMonitorId, Collections.emptyMap());
executeResults = entityAsMap(executeResponse);
noOfSigmaRuleMatches = ((List<Map<String, Object>>) ((Map<String, Object>) executeResults.get("input_results")).get("results")).get(0).size();
Assert.assertEquals(1, noOfSigmaRuleMatches);
Thread.sleep(5000);

// Call GetFindings API
Map<String, String> params = new HashMap<>();
params.put("detectorType", "test_windows");
Response getFindingsResponse = makeRequest(client(), "GET", SecurityAnalyticsPlugin.FINDINGS_BASE_URI + "/_search", params, null);
Map<String, Object> getFindingsBody = entityAsMap(getFindingsResponse);
String finding = ((List<Map<String, Object>>) getFindingsBody.get("findings")).get(0).get("id").toString();
try {
List<Map<String, Object>> correlatedFindings = searchCorrelatedFindings(finding, "test_windows", 300000L, 10);
fail();
} catch (Exception e) {
assertTrue(e.getMessage().contains("no such index"));
}

OpenSearchRestTestCase.waitUntil(
() -> {
try {
List<Map<String, Object>> correlatedFindings = searchCorrelatedFindings(finding, "test_windows", 300000L, 10);
if (correlatedFindings.size() == 1) {
Assert.assertTrue(true);

Assert.assertTrue(correlatedFindings.get(0).get("rules") instanceof List);

for (var correlatedFinding: correlatedFindings) {
if (correlatedFinding.get("detector_type").equals("network")) {
Assert.assertEquals(1, ((List<String>) correlatedFinding.get("rules")).size());
Assert.assertTrue(((List<String>) correlatedFinding.get("rules")).contains(ruleId));
return true;
}
}
}
return false;
} catch (Exception ex) {
return false;
}
},
2, TimeUnit.MINUTES
);
}

public void testBasicCorrelationEngineWorkflowWithFieldBasedRulesAndDynamicTimeWindow() throws IOException, InterruptedException {
Expand Down
75 changes: 0 additions & 75 deletions src/test/java/org/opensearch/securityanalytics/mapper/MapperRestApiIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -715,81 +715,6 @@ public void testCreateMappings_withIndexPattern_existing_indexTemplate_update_su
assertTrue(props.containsKey("destination.port"));
}

public void testCreateMappings_withIndexPattern_differentMappings_indexTemplateCleanup_success() throws IOException, InterruptedException {
String indexName1 = "test_index_1";
String indexName2 = "test_index_2";
String indexPattern = "test_index*";

createIndex(indexName1, Settings.EMPTY, null);
createIndex(indexName2, Settings.EMPTY, null);

// client().performRequest(new Request("POST", "_refresh"));

// Insert sample docs
String sampleDoc1 = "{" +
" \"netflow.source_ipv4_address\":\"10.50.221.10\"," +
" \"netflow.destination_transport_port\":1234," +
" \"netflow.source_transport_port\":4444" +
"}";
String sampleDoc2 = "{" +
" \"netflow.destination_transport_port\":1234," +
" \"netflow.destination_ipv4_address\":\"10.53.111.14\"" +
"}";
indexDoc(indexName1, "1", sampleDoc1);
indexDoc(indexName2, "1", sampleDoc2);

// client().performRequest(new Request("POST", "_refresh"));

// Execute CreateMappingsAction to add alias mapping for index
createMappingsAPI(indexPattern, "netflow");

DetectorInput input = new DetectorInput("", List.of(indexPattern), List.of(),
getRandomPrePackagedRules().stream().map(DetectorRule::new).collect(Collectors.toList()));
String detectorId = createDetector(TestHelpers.randomDetectorWithInputs(List.of((input))));

refreshAllIndices();

List<Object> componentTemplates = getAllComponentTemplates();
assertEquals(1, componentTemplates.size());
List<Object> composableIndexTemplates = getAllComposableIndexTemplates();
assertEquals(2, composableIndexTemplates.size());

deleteDetector(detectorId);

// Wait for clusterState update to be published/applied
OpenSearchTestCase.waitUntil(() -> {
try {
List<Object> ct = getAllComponentTemplates();
if (ct.size() == 0) {
return true;
} else {
return false;
}
} catch (IOException e) {

}
return false;
});
OpenSearchTestCase.waitUntil(() -> {
try {
List<Object> cct = getAllComposableIndexTemplates();
if (cct.size() == 1) {
return true;
} else {
return false;
}
} catch (IOException e) {

}
return false;
});

componentTemplates = getAllComponentTemplates();
assertEquals(0, componentTemplates.size());
composableIndexTemplates = getAllComposableIndexTemplates();
assertEquals(1, composableIndexTemplates.size());
}

public void testCreateMappings_withIndexPattern_indexTemplate_createAndUpdate_success() throws IOException {
String indexName1 = "test_index_1";
String indexName2 = "test_index_2";
Expand Down
Loading