[8.19] [Security Solution] Adds ability to revert prebuilt rules to their base version (#223301)

x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/model/rule_schema/utils.ts

@@ -10,3 +10,7 @@ import type { RuleResponse } from './rule_schemas.gen';
 export function isCustomizedPrebuiltRule(rule: RuleResponse): boolean {
   return rule.rule_source?.type === 'external' && rule.rule_source.is_customized;
 }
+
+export function isNonCustomizedPrebuiltRule(rule: RuleResponse): boolean {
+  return rule.rule_source?.type === 'external' && rule.rule_source.is_customized === false;
+}

x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/prebuilt_rules/get_prebuilt_rule_base_version/get_prebuilt_rule_base_version_route.ts

@@ -0,0 +1,26 @@
+/*
+ * 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 { z } from '@kbn/zod';
+import type { RuleResponse } from '../../model/rule_schema/rule_schemas.gen';
+import type { PartialRuleDiff } from '../model';
+
+export type GetPrebuiltRuleBaseVersionRequest = z.infer<typeof GetPrebuiltRuleBaseVersionRequest>;
+export const GetPrebuiltRuleBaseVersionRequest = z.object({
+  id: z.string(),
+});
+
+export interface GetPrebuiltRuleBaseVersionResponseBody {
+  /** The base version of the rule */
+  base_version: RuleResponse;
+
+  /** The current version of the rule */
+  current_version: RuleResponse;
+
+  /** The resulting diff between the base and current versions of the rule */
+  diff: PartialRuleDiff;
+}

x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/prebuilt_rules/index.ts

@@ -23,3 +23,5 @@ export * from './model/diff/three_way_diff/three_way_diff';
 export * from './model/diff/three_way_diff/three_way_diff_conflict';
 export * from './model/diff/three_way_diff/three_way_merge_outcome';
 export * from './common/prebuilt_rules_filter';
+export * from './revert_prebuilt_rule/revert_prebuilt_rule_route';
+export * from './get_prebuilt_rule_base_version/get_prebuilt_rule_base_version_route';

x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/prebuilt_rules/revert_prebuilt_rule/revert_prebuilt_rule_route.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 { z } from '@kbn/zod';
+import { RuleResponse } from '../../model/rule_schema/rule_schemas.gen';
+import { NormalizedRuleError } from '../../rule_management';
+
+export type RevertPrebuiltRulesRequest = z.infer<typeof RevertPrebuiltRulesRequest>;
+export const RevertPrebuiltRulesRequest = z.object({
+  /** ID of rule to revert */
+  id: z.string(),
+
+  /** Revision of rule to guard against concurrence */
+  revision: z.number(),
+
+  /** Version of rule to guard against concurrence */
+  version: z.number(),
+});
+
+export type BulkRevertSkipReason = z.infer<typeof BulkRevertSkipReason>;
+export const BulkRevertSkipReason = z.enum(['RULE_NOT_PREBUILT', 'RULE_NOT_CUSTOMIZED']);
+export type BulkRevertSkipReasonEnum = typeof BulkRevertSkipReason.enum;
+export const BulkRevertSkipReasonEnum = BulkRevertSkipReason.enum;
+
+export type BulkActionReversionSkipResult = z.infer<typeof BulkActionReversionSkipResult>;
+export const BulkActionReversionSkipResult = z.object({
+  id: z.string(),
+  skip_reason: BulkRevertSkipReason,
+});
+
+export type RevertPrebuiltRulesResponseBody = z.infer<typeof RevertPrebuiltRulesResponseBody>;
+export const RevertPrebuiltRulesResponseBody = z.object({
+  success: z.boolean().optional(),
+  status_code: z.number().int().optional(),
+  message: z.string().optional(),
+  rules_count: z.number().int().optional(),
+  attributes: z.object({
+    results: z.object({
+      updated: z.array(RuleResponse), // An array of the rule objects reverted to their base version
+      created: z.array(RuleResponse),
+      deleted: z.array(RuleResponse),
+      skipped: z.array(BulkActionReversionSkipResult), // An array of the rule ids and reasons that were skipped during reversion (due to being already non-customized)
+    }),
+    summary: z.object({
+      failed: z.number().int(),
+      skipped: z.number().int(),
+      succeeded: z.number().int(),
+      total: z.number().int(),
+    }),
+    errors: z.array(NormalizedRuleError).optional(), // An array of error objects, something containing the id of the rule causing the error and the reason behind it (e.g. no base version, rule is not a prebuilt Elastic rule)
+  }),
+});

x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/prebuilt_rules/urls.ts

@@ -17,8 +17,10 @@ export const PREBUILT_RULES_URL = LEGACY_BASE_URL;
 export const PREBUILT_RULES_STATUS_URL = `${LEGACY_BASE_URL}/_status` as const;
 
 export const GET_PREBUILT_RULES_STATUS_URL = `${BASE_URL}/status` as const;
+export const GET_PREBUILT_RULES_BASE_VERSION_URL = `${BASE_URL}/base_version` as const;
 export const BOOTSTRAP_PREBUILT_RULES_URL = `${BASE_URL}/_bootstrap` as const;
 export const REVIEW_RULE_UPGRADE_URL = `${BASE_URL}/upgrade/_review` as const;
 export const PERFORM_RULE_UPGRADE_URL = `${BASE_URL}/upgrade/_perform` as const;
 export const REVIEW_RULE_INSTALLATION_URL = `${BASE_URL}/installation/_review` as const;
 export const PERFORM_RULE_INSTALLATION_URL = `${BASE_URL}/installation/_perform` as const;
+export const REVERT_PREBUILT_RULES_URL = `${BASE_URL}/revert` as const;

x-pack/solutions/security/plugins/security_solution/common/detection_engine/prebuilt_rules/diff/convert_rule_to_diffable.ts

@@ -54,6 +54,7 @@ import { extractRuleSchedule } from './extract_rule_schedule';
 import { extractTimelineTemplateReference } from './extract_timeline_template_reference';
 import { extractTimestampOverrideObject } from './extract_timestamp_override_object';
 import { extractThreatArray } from './extract_threat_array';
+import { normalizeRuleThreshold } from './normalize_rule_threshold';
 
 /**
  * Normalizes a given rule to the form which is suitable for passing to the diff algorithm.
@@ -224,7 +225,7 @@ const extractDiffableThresholdFieldsFromRuleObject = (
     type: rule.type,
     kql_query: extractRuleKqlQuery(rule.query, rule.language, rule.filters, rule.saved_id),
     data_source: extractRuleDataSource(rule.index, rule.data_view_id),
-    threshold: rule.threshold,
+    threshold: normalizeRuleThreshold(rule.threshold),
     alert_suppression: rule.alert_suppression,
   };
 };

x-pack/solutions/security/plugins/security_solution/common/detection_engine/prebuilt_rules/diff/normalize_rule_threshold.test.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 { normalizeRuleThreshold } from './normalize_rule_threshold';
+
+describe('normalizeRuleThreshold', () => {
+  it('returns threshold without cardinality field when array is empty', () => {
+    const normalizedField = normalizeRuleThreshold({
+      value: 30,
+      field: ['field'],
+      cardinality: [],
+    });
+
+    expect(normalizedField).toEqual({ value: 30, field: ['field'] });
+  });
+
+  it('returns cardinality field when it is populated', () => {
+    const normalizedField = normalizeRuleThreshold({
+      value: 30,
+      field: ['field'],
+      cardinality: [{ value: 20, field: 'field-cardinality' }],
+    });
+
+    expect(normalizedField).toEqual({
+      value: 30,
+      field: ['field'],
+      cardinality: [{ value: 20, field: 'field-cardinality' }],
+    });
+  });
+});

x-pack/solutions/security/plugins/security_solution/common/detection_engine/prebuilt_rules/diff/normalize_rule_threshold.ts

@@ -0,0 +1,18 @@
+/*
+ * 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 type { Threshold } from '../../../api/detection_engine/model/rule_schema';
+
+export const normalizeRuleThreshold = (threshold: Threshold): Threshold => {
+  const cardinality =
+    threshold.cardinality && threshold.cardinality.length ? threshold.cardinality : undefined;
+  return {
+    value: threshold.value,
+    field: threshold.field,
+    cardinality,
+  };
+};

x-pack/solutions/security/plugins/security_solution/public/detection_engine/common/translations.ts

@@ -724,6 +724,28 @@ export const EXPORT_RULE = i18n.translate(
   }
 );
 
+export const REVERT_RULE = i18n.translate(
+  'xpack.securitySolution.detectionEngine.rules.allRules.actions.revertRuleDescription',
+  {
+    defaultMessage: 'Revert to Elastic version',
+  }
+);
+
+export const REVERT_RULE_TOOLTIP_TITLE = i18n.translate(
+  'xpack.securitySolution.detectionEngine.rules.allRules.actions.revertRuleTooltipTitle',
+  {
+    defaultMessage: 'Unable to revert rule',
+  }
+);
+
+export const REVERT_RULE_TOOLTIP_CONTENT = i18n.translate(
+  'xpack.securitySolution.detectionEngine.rules.allRules.actions.revertRuleTooltipContent',
+  {
+    defaultMessage:
+      "This rule hasn't been updated in a while and there's no available version to revert to. We recommend updating this rule instead.",
+  }
+);
+
 export const DELETE_RULE = i18n.translate(
   'xpack.securitySolution.detectionEngine.rules.allRules.actions.deleteRuleDescription',
   {

x-pack/solutions/security/plugins/security_solution/public/detection_engine/rule_details_ui/pages/rule_details/index.tsx

@@ -155,6 +155,7 @@ import { useLegacyUrlRedirect } from './use_redirect_legacy_url';
 import { RuleDetailTabs, useRuleDetailsTabs } from './use_rule_details_tabs';
 import { useIsExperimentalFeatureEnabled } from '../../../../common/hooks/use_experimental_features';
 import { useRuleUpdateCallout } from '../../../rule_management/hooks/use_rule_update_callout';
+import { usePrebuiltRulesViewBaseDiff } from '../../../rule_management/hooks/use_prebuilt_rules_view_base_diff';
 
 const RULE_EXCEPTION_LIST_TYPES = [
   ExceptionListTypeEnum.DETECTION,
@@ -433,6 +434,18 @@ const RuleDetailsPageComponent: React.FC<DetectionEngineComponentProps> = ({
     onUpgrade: refreshRule,
   });
 
+  const {
+    baseVersionFlyout,
+    openFlyout,
+    doesBaseVersionExist,
+    isLoading: isBaseVersionLoading,
+  } = usePrebuiltRulesViewBaseDiff({ rule, onRevert: refreshRule });
+
+  const isRevertBaseVersionDisabled = useMemo(
+    () => !doesBaseVersionExist || isBaseVersionLoading,
+    [doesBaseVersionExist, isBaseVersionLoading]
+  );
+
   const ruleStatusInfo = useMemo(() => {
     return (
       <>
@@ -609,6 +622,7 @@ const RuleDetailsPageComponent: React.FC<DetectionEngineComponentProps> = ({
       <NeedAdminForUpdateRulesCallOut />
       <MissingPrivilegesCallOut />
       {upgradeCallout}
+      {baseVersionFlyout}
       {isBulkDuplicateConfirmationVisible && (
         <BulkActionDuplicateExceptionsConfirmation
           onCancel={cancelRuleDuplication}
@@ -723,6 +737,8 @@ const RuleDetailsPageComponent: React.FC<DetectionEngineComponentProps> = ({
                           showBulkDuplicateExceptionsConfirmation={showBulkDuplicateConfirmation}
                           showManualRuleRunConfirmation={showManualRuleRunConfirmation}
                           confirmDeletion={confirmDeletion}
+                          isRevertBaseVersionDisabled={isRevertBaseVersionDisabled}
+                          openRuleDiffFlyout={openFlyout}
                         />
                       </EuiFlexItem>
                     </EuiFlexGroup>