Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export const bootstrapPrebuiltRulesHandler = async (
const packageResults: PackageInstallStatus[] = [];

// Install packages sequentially to avoid high memory usage
const prebuiltRulesResult = await installPrebuiltRulesPackage(config, securityContext);
const prebuiltRulesResult = await installPrebuiltRulesPackage(securityContext);
packageResults.push({
name: prebuiltRulesResult.package.name,
version: prebuiltRulesResult.package.version,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ export const legacyCreatePrepackagedRules = async (
rulesClient: RulesClient,
exceptionsClient?: ExceptionListClient
): Promise<InstallPrebuiltRulesAndTimelinesResponse> => {
const config = context.getConfig();
const savedObjectsClient = context.core.savedObjects.client;
const siemClient = context.getAppClient();
const exceptionsListClient = context.getExceptionListClient() ?? exceptionsClient;
Expand All @@ -53,11 +52,7 @@ export const legacyCreatePrepackagedRules = async (
await exceptionsListClient.createEndpointList();
}

const latestPrebuiltRules = await ensureLatestRulesPackageInstalled(
ruleAssetsClient,
config,
context
);
const latestPrebuiltRules = await ensureLatestRulesPackageInstalled(ruleAssetsClient, context);

const installedPrebuiltRules = rulesToMap(await getExistingPrepackagedRules({ rulesClient }));
const rulesToInstall = getRulesToInstall(latestPrebuiltRules, installedPrebuiltRules);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export const performRuleInstallationHandler = async (

try {
const ctx = await context.resolve(['core', 'alerting', 'securitySolution']);
const config = ctx.securitySolution.getConfig();
const soClient = ctx.core.savedObjects.client;
const rulesClient = await ctx.alerting.getRulesClient();
const detectionRulesClient = ctx.securitySolution.getDetectionRulesClient();
Expand All @@ -47,7 +46,7 @@ export const performRuleInstallationHandler = async (

// If this API is used directly without hitting any detection engine
// pages first, the rules package might be missing.
await ensureLatestRulesPackageInstalled(ruleAssetsClient, config, ctx.securitySolution);
await ensureLatestRulesPackageInstalled(ruleAssetsClient, ctx.securitySolution);

const allLatestVersions = await ruleAssetsClient.fetchLatestVersions();
const currentRuleVersions = await ruleObjectsClient.fetchInstalledRuleVersions();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,18 @@
* 2.0.
*/

import type { ConfigType } from '../../../../../config';
import type { SecuritySolutionApiRequestHandlerContext } from '../../../../../types';
import type { IPrebuiltRuleAssetsClient } from '../rule_assets/prebuilt_rule_assets_client';
import { installPrebuiltRulesPackage } from './install_prebuilt_rules_package';

export async function ensureLatestRulesPackageInstalled(
ruleAssetsClient: IPrebuiltRuleAssetsClient,
config: ConfigType,
securityContext: SecuritySolutionApiRequestHandlerContext
) {
let latestPrebuiltRules = await ruleAssetsClient.fetchLatestAssets();
if (latestPrebuiltRules.length === 0) {
// Seems no packages with prepackaged rules were installed, try to install the default rules package
await installPrebuiltRulesPackage(config, securityContext);
await installPrebuiltRulesPackage(securityContext);

// Try to get the prepackaged rules again
latestPrebuiltRules = await ruleAssetsClient.fetchLatestAssets();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import { ELASTIC_SECURITY_RULE_ID } from '../../../../../../common';
import { createPrebuiltRuleObjectsClient } from '../rule_objects/prebuilt_rule_objects_client';
import { createPrebuiltRuleAssetsClient } from '../rule_assets/prebuilt_rule_assets_client';
import { createPrebuiltRules } from '../rule_objects/create_prebuilt_rules';
import { ensureLatestRulesPackageInstalled } from './ensure_latest_rules_package_installed';

export interface InstallEndpointSecurityPrebuiltRuleProps {
logger: Logger;
Expand Down Expand Up @@ -65,6 +66,11 @@ export const installEndpointSecurityPrebuiltRule = async ({
// This will create the endpoint list if it does not exist yet
await exceptionsListClient?.createEndpointList();

// Make sure the latest prebuilt rules package is installed (in case the
// user installs Elastic Defend integration without visiting Security
// Solution first)
await ensureLatestRulesPackageInstalled(ruleAssetsClient, context);

const latestRuleVersion = await ruleAssetsClient.fetchLatestVersions([
ELASTIC_SECURITY_RULE_ID,
]);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

import type { SecuritySolutionApiRequestHandlerContext } from '../../../../../types';
import { PREBUILT_RULES_PACKAGE_NAME } from '../../../../../../common/detection_engine/constants';
import type { ConfigType } from '../../../../../config';
import { findLatestPackageVersion } from './find_latest_package_version';

/**
Expand All @@ -17,9 +16,9 @@ import { findLatestPackageVersion } from './find_latest_package_version';
* @param context Request handler context
*/
export async function installPrebuiltRulesPackage(
config: ConfigType,
context: SecuritySolutionApiRequestHandlerContext
) {
const config = context.getConfig();
let pkgVersion = config.prebuiltRulesPackageVersion;

if (!pkgVersion) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,6 @@ export const importRulesRoute = (router: SecuritySolutionPluginRouter, config: C
);

const ruleSourceImporter = createRuleSourceImporter({
config,
context: ctx.securitySolution,
prebuiltRuleAssetsClient: createPrebuiltRuleAssetsClient(savedObjectsClient),
prebuiltRuleObjectsClient: createPrebuiltRuleObjectsClient(rulesClient),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,19 @@ import type {
} from '../../../../../../../common/api/detection_engine';
import { createPrebuiltRuleAssetsClient as createPrebuiltRuleAssetsClientMock } from '../../../../prebuilt_rules/logic/rule_assets/__mocks__/prebuilt_rule_assets_client';
import { createPrebuiltRuleObjectsClient as createPrebuiltRuleObjectsClientMock } from '../../../../prebuilt_rules/logic/rule_objects/__mocks__/prebuilt_rule_objects_client';
import { createMockConfig, requestContextMock } from '../../../../routes/__mocks__';
import { requestContextMock } from '../../../../routes/__mocks__';
import { getPrebuiltRuleMock } from '../../../../prebuilt_rules/mocks';
import { createRuleSourceImporter } from './rule_source_importer';

describe('ruleSourceImporter', () => {
let ruleAssetsClientMock: ReturnType<typeof createPrebuiltRuleAssetsClientMock>;
let ruleObjectsClientMock: ReturnType<typeof createPrebuiltRuleObjectsClientMock>;
let config: ReturnType<typeof createMockConfig>;
let context: ReturnType<typeof requestContextMock.create>['securitySolution'];
let ruleToImport: RuleToImport;
let subject: ReturnType<typeof createRuleSourceImporter>;

beforeEach(() => {
jest.clearAllMocks();
config = createMockConfig();
context = requestContextMock.create().securitySolution;
ruleAssetsClientMock = createPrebuiltRuleAssetsClientMock();
ruleAssetsClientMock.fetchLatestAssets.mockResolvedValue([{}]);
Expand All @@ -37,7 +35,6 @@ describe('ruleSourceImporter', () => {

subject = createRuleSourceImporter({
context,
config,
prebuiltRuleAssetsClient: ruleAssetsClientMock,
prebuiltRuleObjectsClient: ruleObjectsClientMock,
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
*/

import type { SecuritySolutionApiRequestHandlerContext } from '../../../../../../types';
import type { ConfigType } from '../../../../../../config';
import type {
RuleResponse,
RuleToImport,
Expand Down Expand Up @@ -95,7 +94,6 @@ const fetchMatchingAssets = async ({
*/
export class RuleSourceImporter implements IRuleSourceImporter {
private context: SecuritySolutionApiRequestHandlerContext;
private config: ConfigType;
private ruleAssetsClient: IPrebuiltRuleAssetsClient;
private ruleObjectsClient: IPrebuiltRuleObjectsClient;
private latestPackagesInstalled: boolean = false;
Expand All @@ -105,17 +103,14 @@ export class RuleSourceImporter implements IRuleSourceImporter {
private availableRuleAssetIds: Set<string> = new Set();

constructor({
config,
context,
prebuiltRuleAssetsClient,
prebuiltRuleObjectsClient,
}: {
config: ConfigType;
context: SecuritySolutionApiRequestHandlerContext;
prebuiltRuleAssetsClient: IPrebuiltRuleAssetsClient;
prebuiltRuleObjectsClient: IPrebuiltRuleObjectsClient;
}) {
this.config = config;
this.ruleAssetsClient = prebuiltRuleAssetsClient;
this.ruleObjectsClient = prebuiltRuleObjectsClient;
this.context = context;
Expand All @@ -128,7 +123,7 @@ export class RuleSourceImporter implements IRuleSourceImporter {
*/
public async setup(rules: RuleToImport[]): Promise<void> {
if (!this.latestPackagesInstalled) {
await ensureLatestRulesPackageInstalled(this.ruleAssetsClient, this.config, this.context);
await ensureLatestRulesPackageInstalled(this.ruleAssetsClient, this.context);
this.latestPackagesInstalled = true;
}

Expand Down Expand Up @@ -209,18 +204,15 @@ export class RuleSourceImporter implements IRuleSourceImporter {
}

export const createRuleSourceImporter = ({
config,
context,
prebuiltRuleAssetsClient,
prebuiltRuleObjectsClient,
}: {
config: ConfigType;
context: SecuritySolutionApiRequestHandlerContext;
prebuiltRuleAssetsClient: IPrebuiltRuleAssetsClient;
prebuiltRuleObjectsClient: IPrebuiltRuleObjectsClient;
}): RuleSourceImporter => {
return new RuleSourceImporter({
config,
context,
prebuiltRuleAssetsClient,
prebuiltRuleObjectsClient,
Expand Down