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

[Security Solution] Coverage overview rule duplication fix #169708

Merged
merged 9 commits into from
Nov 6, 2023
Merged

[Security Solution] Coverage overview rule duplication fix #169708

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e049eaa
fixes count and duplication bugs
dplumlee Oct 24, 2023
398be3b
Merge remote-tracking branch 'upstream/main' into coverage-overview-d…
dplumlee Oct 24, 2023
62d0549
Merge remote-tracking branch 'upstream/main' into coverage-overview-d…
dplumlee Oct 26, 2023
e5e68e4
adds tests
dplumlee Oct 27, 2023
c6c0321
fixes syntax
dplumlee Oct 27, 2023
ae0a7a1
Merge remote-tracking branch 'upstream/main' into coverage-overview-d…
dplumlee Nov 1, 2023
1db2b04
addresses comments
dplumlee Nov 1, 2023
3b17006
addresses comments
dplumlee Nov 6, 2023
4222c8a
Merge branch 'main' into coverage-overview-duplication-bug
kibanamachine Nov 6, 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
293 changes: 293 additions & 0 deletions ...e/rule_management/logic/coverage_overview/build_coverage_overview_dashboard_model.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,293 @@
/*
* 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.
*/

import { CoverageOverviewRuleActivity } from '../../../../../common/api/detection_engine';
import type { CoverageOverviewResponse } from '../../../../../common/api/detection_engine';
import { buildCoverageOverviewDashboardModel } from './build_coverage_overview_dashboard_model';
import {
getMockCoverageOverviewSubtechniques,
getMockCoverageOverviewTactics,
getMockCoverageOverviewTechniques,
} from '../../model/coverage_overview/__mocks__';

const mockTactics = getMockCoverageOverviewTactics();
const mockTechniques = getMockCoverageOverviewTechniques();
const mockSubtechniques = getMockCoverageOverviewSubtechniques();

describe('buildCoverageOverviewDashboardModel', () => {
beforeEach(() => {
jest.mock('../../../../detections/mitre/mitre_tactics_techniques', () => {
return {
tactics: mockTactics,
techniques: mockTechniques,
subtechniques: mockSubtechniques,
};
});
});

afterEach(() => {
jest.clearAllMocks();
});

it('maps API response', async () => {
const mockApiResponse: CoverageOverviewResponse = {
coverage: {
TA001: ['test-rule-1'],
TA002: ['test-rule-1'],
T001: ['test-rule-1'],
T002: ['test-rule-1'],
'T001.001': ['test-rule-1'],
},
unmapped_rule_ids: [],
dplumlee marked this conversation as resolved.
Show resolved Hide resolved
rules_data: {
'test-rule-1': {
name: 'Test rule',
activity: CoverageOverviewRuleActivity.Enabled,
},
},
};

const model = await buildCoverageOverviewDashboardModel(mockApiResponse);

expect(model).toEqual({
metrics: {
totalEnabledRulesCount: 1,
totalRulesCount: 1,
},
mitreTactics: [
{
availableRules: [],
disabledRules: [],
enabledRules: [
{
id: 'test-rule-1',
name: 'Test rule',
},
],
id: 'TA001',
name: 'Tactic 1',
reference: 'https://some-link/TA001',
techniques: [
{
availableRules: [],
disabledRules: [],
enabledRules: [
{
id: 'test-rule-1',
name: 'Test rule',
},
],
id: 'T001',
name: 'Technique 1',
reference: 'https://some-link/T001',
subtechniques: [
{
availableRules: [],
disabledRules: [],
enabledRules: [
{
id: 'test-rule-1',
name: 'Test rule',
},
],
id: 'T001.001',
name: 'Subtechnique 1',
reference: 'https://some-link/T001/001',
},
{
availableRules: [],
disabledRules: [],
enabledRules: [],
id: 'T001.002',
name: 'Subtechnique 2',
reference: 'https://some-link/T001/002',
},
],
},
{
availableRules: [],
disabledRules: [],
enabledRules: [
{
id: 'test-rule-1',
name: 'Test rule',
},
],
id: 'T002',
name: 'Technique 2',
reference: 'https://some-link/T002',
subtechniques: [],
},
],
},
{
availableRules: [],
disabledRules: [],
enabledRules: [
{
id: 'test-rule-1',
name: 'Test rule',
},
],
id: 'TA002',
name: 'Tactic 2',
reference: 'https://some-link/TA002',
techniques: [
{
availableRules: [],
disabledRules: [],
enabledRules: [
{
id: 'test-rule-1',
name: 'Test rule',
},
],
id: 'T002',
name: 'Technique 2',
reference: 'https://some-link/T002',
subtechniques: [],
},
],
},
],
unmappedRules: {
availableRules: [],
disabledRules: [],
enabledRules: [],
},
});
});

it('maps techniques that appear in multiple tactics', async () => {
const mockApiResponse: CoverageOverviewResponse = {
coverage: {
TA001: ['test-rule-1', 'test-rule-2'],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: We don't care about rule ids here so shorter is better, something like id1, id2 or id-1, id-2 is much shorter.

TA002: ['test-rule-2'],
T002: ['test-rule-1', 'test-rule-2'],
},
unmapped_rule_ids: [],
rules_data: {
'test-rule-1': {
name: 'Test rule',
activity: CoverageOverviewRuleActivity.Enabled,
},
'test-rule-2': {
name: 'Test rule 2',
activity: CoverageOverviewRuleActivity.Enabled,
},
},
};

const model = await buildCoverageOverviewDashboardModel(mockApiResponse);

expect(model).toEqual({
dplumlee marked this conversation as resolved.
Show resolved Hide resolved
metrics: {
totalEnabledRulesCount: 2,
totalRulesCount: 2,
},
mitreTactics: [
{
availableRules: [],
disabledRules: [],
enabledRules: [
{
id: 'test-rule-1',
name: 'Test rule',
},
{
id: 'test-rule-2',
name: 'Test rule 2',
},
],
id: 'TA001',
name: 'Tactic 1',
reference: 'https://some-link/TA001',
techniques: [
{
availableRules: [],
disabledRules: [],
enabledRules: [],
id: 'T001',
name: 'Technique 1',
reference: 'https://some-link/T001',
subtechniques: [
{
availableRules: [],
disabledRules: [],
enabledRules: [],
id: 'T001.001',
name: 'Subtechnique 1',
reference: 'https://some-link/T001/001',
},
{
availableRules: [],
disabledRules: [],
enabledRules: [],
id: 'T001.002',
name: 'Subtechnique 2',
reference: 'https://some-link/T001/002',
},
],
},
{
availableRules: [],
disabledRules: [],
enabledRules: [
{
id: 'test-rule-1',
name: 'Test rule',
},
{
id: 'test-rule-2',
name: 'Test rule 2',
},
],
id: 'T002',
name: 'Technique 2',
reference: 'https://some-link/T002',
subtechniques: [],
},
],
},
{
availableRules: [],
disabledRules: [],
enabledRules: [
{
id: 'test-rule-2',
name: 'Test rule 2',
},
],
id: 'TA002',
name: 'Tactic 2',
reference: 'https://some-link/TA002',
techniques: [
{
availableRules: [],
disabledRules: [],
enabledRules: [
{
id: 'test-rule-2',
name: 'Test rule 2',
},
],
id: 'T002',
name: 'Technique 2',
reference: 'https://some-link/T002',
subtechniques: [],
},
],
},
],
unmappedRules: {
availableRules: [],
disabledRules: [],
enabledRules: [],
},
});
});
});
8 changes: 6 additions & 2 deletions ...engine/rule_management/logic/coverage_overview/build_coverage_overview_dashboard_model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,16 @@ export async function buildCoverageOverviewDashboardModel(

for (const technique of tactic.techniques) {
for (const ruleId of apiResponse.coverage[technique.id] ?? []) {
addRule(technique, ruleId, apiResponse.rules_data[ruleId]);
if (apiResponse.coverage[tactic.id]?.includes(ruleId)) {
addRule(technique, ruleId, apiResponse.rules_data[ruleId]);
}
}

for (const subtechnique of technique.subtechniques) {
for (const ruleId of apiResponse.coverage[subtechnique.id] ?? []) {
addRule(subtechnique, ruleId, apiResponse.rules_data[ruleId]);
if (apiResponse.coverage[tactic.id]?.includes(ruleId)) {
addRule(subtechnique, ruleId, apiResponse.rules_data[ruleId]);
}
}
}
}
Expand Down
65 changes: 9 additions & 56 deletions ...ngine/rule_management/logic/coverage_overview/build_coverage_overview_mitre_graph.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,66 +5,19 @@
* 2.0.
*/

import {
getMockCoverageOverviewTactics,
getMockCoverageOverviewTechniques,
getMockCoverageOverviewSubtechniques,
} from '../../model/coverage_overview/__mocks__';
import { buildCoverageOverviewMitreGraph } from './build_coverage_overview_mitre_graph';

describe('buildCoverageOverviewModel', () => {
it('builds domain model', () => {
const tactics = [
{
name: 'Tactic 1',
id: 'TA001',
reference: 'https://some-link/TA001',
label: 'Tactic 1',
value: 'tactic1',
},
{
name: 'Tactic 2',
id: 'TA002',
reference: 'https://some-link/TA002',
label: 'Tactic 2',
value: 'tactic2',
},
];
const techniques = [
{
name: 'Technique 1',
id: 'T001',
reference: 'https://some-link/T001',
tactics: ['tactic-1'],
label: 'Technique 1',
value: 'technique1',
},
{
name: 'Technique 2',
id: 'T002',
reference: 'https://some-link/T002',
tactics: ['tactic-1', 'tactic-2'],
label: 'Technique 2',
value: 'technique2',
},
];
const subtechniques = [
{
name: 'Subtechnique 1',
id: 'T001.001',
reference: 'https://some-link/T001/001',
tactics: ['tactic-1'],
techniqueId: 'T001',
label: 'Subtechnique 1',
value: 'subtechnique1',
},
{
name: 'Subtechnique 2',
id: 'T001.002',
reference: 'https://some-link/T001/002',
tactics: ['tactic-1'],
techniqueId: 'T001',
label: 'Subtechnique 2',
value: 'subtechnique2',
},
];

const model = buildCoverageOverviewMitreGraph(tactics, techniques, subtechniques);
const mockTactics = getMockCoverageOverviewTactics();
const mockTechniques = getMockCoverageOverviewTechniques();
const mockSubtechniques = getMockCoverageOverviewSubtechniques();
const model = buildCoverageOverviewMitreGraph(mockTactics, mockTechniques, mockSubtechniques);

expect(model).toEqual([
{
Expand Down
Loading