[Cloud Security] Misconfiguration preview & Refactor CSP Plugin to include new package PHASE 3

x-pack/packages/kbn-cloud-security-posture-common/index.ts

@@ -19,4 +19,5 @@ export type {
   CspFinding,
 } from './types';
 export * from './constants';
-export type { CspBenchmarkRuleMetadata, CspBenchmarkRulesStates } from './schema/rules';
+export { extractErrorMessage, buildMutedRulesFilter } from './utils/helpers';
+export { showErrorToast } from './utils/show_error_toast';

x-pack/packages/kbn-cloud-security-posture-common/schema/rules/index.ts

@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+export * as rulesV1 from './v1';
+export * as rulesV2 from './v2';
+export * as rulesV3 from './v3';
+export * as rulesV4 from './v4';
+export * as rulesV5 from './v5';

x-pack/packages/kbn-cloud-security-posture-common/schema/index.ts → x-pack/packages/kbn-cloud-security-posture-common/schema/rules/latest.ts

@@ -5,4 +5,4 @@
  * 2.0.
  */
 
-export { ruleStateAttributes, cspBenchmarkRuleMetadataSchema, rulesStates } from './rules';
+export * from './v5';

x-pack/plugins/cloud_security_posture/common/types/rules/v3.ts → x-pack/packages/kbn-cloud-security-posture-common/schema/rules/v3.ts

@@ -6,17 +6,44 @@
  */
 
 import { schema, TypeOf } from '@kbn/config-schema';
-
-import { cspBenchmarkRuleMetadataSchema } from '@kbn/cloud-security-posture-common/schema';
+import { CSPM_POLICY_TEMPLATE, KSPM_POLICY_TEMPLATE } from '../../constants';
 
 export const DEFAULT_BENCHMARK_RULES_PER_PAGE = 25;
 
 // Since version 8.7.0
 
 export type FindCspBenchmarkRuleRequest = TypeOf<typeof findCspBenchmarkRuleRequestSchema>;
 
+export type CspBenchmarkRuleMetadata = TypeOf<typeof cspBenchmarkRuleMetadataSchema>;
+
 export type CspBenchmarkRule = TypeOf<typeof cspBenchmarkRuleSchema>;
 
+export const cspBenchmarkRuleMetadataSchema = schema.object({
+  audit: schema.string(),
+  benchmark: schema.object({
+    name: schema.string(),
+    posture_type: schema.maybe(
+      schema.oneOf([schema.literal(CSPM_POLICY_TEMPLATE), schema.literal(KSPM_POLICY_TEMPLATE)])
+    ),
+    id: schema.string(),
+    version: schema.string(),
+    rule_number: schema.maybe(schema.string()),
+  }),
+  default_value: schema.maybe(schema.string()),
+  description: schema.string(),
+  id: schema.string(),
+  impact: schema.maybe(schema.string()),
+  name: schema.string(),
+  profile_applicability: schema.string(),
+  rationale: schema.string(),
+  references: schema.maybe(schema.string()),
+  rego_rule_id: schema.string(),
+  remediation: schema.string(),
+  section: schema.string(),
+  tags: schema.arrayOf(schema.string()),
+  version: schema.string(),
+});
+
 export const cspBenchmarkRuleSchema = schema.object({
   metadata: cspBenchmarkRuleMetadataSchema,
 });

x-pack/plugins/cloud_security_posture/common/types/rules/v4.ts → x-pack/packages/kbn-cloud-security-posture-common/schema/rules/v4.ts

@@ -6,11 +6,15 @@
  */
 
 import { schema, TypeOf } from '@kbn/config-schema';
-import type { CspBenchmarkRulesStates } from '@kbn/cloud-security-posture-common';
-import { ruleStateAttributes, rulesStates } from '@kbn/cloud-security-posture-common/schema';
-import { BenchmarksCisId } from '../latest';
+import { BenchmarksCisId } from '../../types/benchmark';
 import { DEFAULT_BENCHMARK_RULES_PER_PAGE } from './v3';
-export type { cspBenchmarkRuleSchema, CspBenchmarkRule, FindCspBenchmarkRuleResponse } from './v3';
+export type {
+  cspBenchmarkRuleMetadataSchema,
+  CspBenchmarkRuleMetadata,
+  cspBenchmarkRuleSchema,
+  CspBenchmarkRule,
+  FindCspBenchmarkRuleResponse,
+} from './v3';
 
 export type FindCspBenchmarkRuleRequest = TypeOf<typeof findCspBenchmarkRuleRequestSchema>;
 
@@ -22,6 +26,8 @@ export type CspBenchmarkRulesBulkActionRequestSchema = TypeOf<
 
 export type RuleStateAttributes = TypeOf<typeof ruleStateAttributes>;
 
+export type CspBenchmarkRulesStates = TypeOf<typeof rulesStates>;
+
 export type CspSettings = TypeOf<typeof cspSettingsSchema>;
 
 export const findCspBenchmarkRuleRequestSchema = schema.object({
@@ -137,6 +143,16 @@ export interface CspBenchmarkRulesBulkActionResponse {
   message: string;
 }
 
+const ruleStateAttributes = schema.object({
+  muted: schema.boolean(),
+  benchmark_id: schema.string(),
+  benchmark_version: schema.string(),
+  rule_number: schema.string(),
+  rule_id: schema.string(),
+});
+
+const rulesStates = schema.recordOf(schema.string(), ruleStateAttributes);
+
 export const cspSettingsSchema = schema.object({
   rules: rulesStates,
 });

x-pack/plugins/cloud_security_posture/common/types/rules/v5.ts → x-pack/packages/kbn-cloud-security-posture-common/schema/rules/v5.ts

@@ -7,13 +7,20 @@
 import { schema, TypeOf } from '@kbn/config-schema';
 import { DEFAULT_BENCHMARK_RULES_PER_PAGE } from './v3';
 
-export type { cspBenchmarkRuleSchema, CspBenchmarkRule, FindCspBenchmarkRuleResponse } from './v3';
+export type {
+  cspBenchmarkRuleMetadataSchema,
+  CspBenchmarkRuleMetadata,
+  cspBenchmarkRuleSchema,
+  CspBenchmarkRule,
+  FindCspBenchmarkRuleResponse,
+} from './v3';
 export type {
   PageUrlParams,
   rulesToUpdate,
   CspBenchmarkRulesBulkActionRequestSchema,
   CspBenchmarkRulesBulkActionResponse,
   RuleStateAttributes,
+  CspBenchmarkRulesStates,
   cspSettingsSchema,
   CspSettings,
   BulkActionBenchmarkRulesResponse,

x-pack/packages/kbn-cloud-security-posture-common/tsconfig.json

@@ -16,5 +16,8 @@
   ],
   "kbn_references": [
     "@kbn/config-schema",
+    "@kbn/data-views-plugin",
+    "@kbn/i18n",
+    "@kbn/core",
   ]
 }

x-pack/packages/kbn-cloud-security-posture-common/types.ts

@@ -5,7 +5,7 @@
  * 2.0.
  */
 import type { EcsDataStream, EcsEvent } from '@elastic/ecs';
-import type { CspBenchmarkRuleMetadata } from './schema/rules';
+import type { CspBenchmarkRuleMetadata } from './schema/rules/latest';
 
 export type CspStatusCode =
   | 'indexed' // latest findings index exists and has results

x-pack/packages/kbn-cloud-security-posture-common/types/benchmark.ts

@@ -0,0 +1,7 @@
+/*
+ * 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.
+ */
+export type BenchmarksCisId = 'cis_k8s' | 'cis_azure' | 'cis_aws' | 'cis_eks' | 'cis_gcp';

x-pack/packages/kbn-cloud-security-posture-common/utils/helpers.ts

@@ -0,0 +1,38 @@
+/*
+ * 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 { QueryDslQueryContainer } from '@kbn/data-views-plugin/common/types';
+import type { CspBenchmarkRulesStates } from '../schema/rules/latest';
+
+export const extractErrorMessage = (e: unknown, defaultMessage = 'Unknown Error'): string => {
+  if (e instanceof Error) return e.message;
+  if (typeof e === 'string') return e;
+
+  return defaultMessage; // TODO: i18n
+};
+
+export const buildMutedRulesFilter = (
+  rulesStates: CspBenchmarkRulesStates
+): QueryDslQueryContainer[] => {
+  const mutedRules = Object.fromEntries(
+    Object.entries(rulesStates).filter(([key, value]) => value.muted === true)
+  );
+
+  const mutedRulesFilterQuery = Object.keys(mutedRules).map((key) => {
+    const rule = mutedRules[key];
+    return {
+      bool: {
+        must: [
+          { term: { 'rule.benchmark.id': rule.benchmark_id } },
+          { term: { 'rule.benchmark.version': rule.benchmark_version } },
+          { term: { 'rule.benchmark.rule_number': rule.rule_number } },
+        ],
+      },
+    };
+  });
+
+  return mutedRulesFilterQuery;
+};

x-pack/plugins/cloud_security_posture/public/common/utils/show_error_toast.ts → x-pack/packages/kbn-cloud-security-posture-common/utils/show_error_toast.ts

@@ -6,7 +6,7 @@
  */
 import type { CoreStart } from '@kbn/core/public';
 import { i18n } from '@kbn/i18n';
-import { extractErrorMessage } from '../../../common/utils/helpers';
+import { extractErrorMessage } from './helpers';
 
 const SEARCH_FAILED_TEXT = i18n.translate(
   'xpack.csp.findings.findingsErrorToast.searchFailedTitle',

x-pack/plugins/cloud_security_posture/public/common/api/use_setup_status_api.ts → x-pack/packages/kbn-cloud-security-posture/src/hooks/use_csp_setup_status_api.ts

@@ -6,16 +6,18 @@
  */
 
 import { useQuery, type UseQueryOptions } from '@tanstack/react-query';
+import { useKibana } from '@kbn/kibana-react-plugin/public';
+import type { CoreStart } from '@kbn/core/public';
 import { STATUS_API_CURRENT_VERSION, STATUS_ROUTE_PATH } from '@kbn/cloud-security-posture-common';
 import type { CspSetupStatus } from '@kbn/cloud-security-posture-common';
-import { useKibana } from '../hooks/use_kibana';
+import type { CspClientPluginStartDeps } from '../../type';
 
 const getCspSetupStatusQueryKey = 'csp_status_key';
 
 export const useCspSetupStatusApi = (
   options?: UseQueryOptions<CspSetupStatus, unknown, CspSetupStatus>
 ) => {
-  const { http } = useKibana().services;
+  const { http } = useKibana<CoreStart & CspClientPluginStartDeps>().services;
   return useQuery<CspSetupStatus, unknown, CspSetupStatus>(
     [getCspSetupStatusQueryKey],
     () => http.get<CspSetupStatus>(STATUS_ROUTE_PATH, { version: STATUS_API_CURRENT_VERSION }),

x-pack/plugins/cloud_security_posture/public/pages/configurations/latest_findings/use_get_benchmark_rules_state_api.ts → x-pack/packages/kbn-cloud-security-posture/src/hooks/use_get_benchmark_rules_state_api.ts

@@ -10,13 +10,15 @@ import {
   CSP_GET_BENCHMARK_RULES_STATE_API_CURRENT_VERSION,
   CSP_GET_BENCHMARK_RULES_STATE_ROUTE_PATH,
 } from '@kbn/cloud-security-posture-common';
-import type { CspBenchmarkRulesStates } from '@kbn/cloud-security-posture-common';
-import { useKibana } from '../../../common/hooks/use_kibana';
+import type { CspBenchmarkRulesStates } from '@kbn/cloud-security-posture-common/schema/rules/latest';
+import { useKibana } from '@kbn/kibana-react-plugin/public';
+import type { CoreStart } from '@kbn/core/public';
+import type { CspClientPluginStartDeps } from '../../type';
 
 export const getRuleStatesKey = ['get_rules_state_key'];
 
 export const useGetCspBenchmarkRulesStatesApi = () => {
-  const { http } = useKibana().services;
+  const { http } = useKibana<CoreStart & CspClientPluginStartDeps>().services;
   return useQuery<CspBenchmarkRulesStates, unknown, CspBenchmarkRulesStates>(getRuleStatesKey, () =>
     http.get<CspBenchmarkRulesStates>(CSP_GET_BENCHMARK_RULES_STATE_ROUTE_PATH, {
       version: CSP_GET_BENCHMARK_RULES_STATE_API_CURRENT_VERSION,

x-pack/packages/kbn-cloud-security-posture/tsconfig.json

@@ -33,5 +33,7 @@
     "@kbn/es-query",
     "@kbn/cloud-plugin",
     "@kbn/spaces-plugin",
+    "@kbn/kibana-react-plugin",
+    "@kbn/cloud-security-posture-common",
   ]
 }

x-pack/plugins/cloud_security_posture/common/types/index.ts

@@ -5,22 +5,8 @@
  * 2.0.
  */
 
-export * as rulesV1 from './rules/v1';
-export * as rulesV2 from './rules/v2';
-export * as rulesV3 from './rules/v3';
-export * as rulesV4 from './rules/v4';
-export * as rulesV5 from './rules/v5';
-
 export * as benchmarkV1 from './benchmarks/v1';
 export * as benchmarkV2 from './benchmarks/v2';
 
 // Explicit export of everything from latest
-export type {
-  CspBenchmarkRule,
-  FindCspBenchmarkRuleRequest,
-  FindCspBenchmarkRuleResponse,
-  BenchmarkScore,
-  Benchmark,
-  GetBenchmarkResponse,
-  BenchmarkRuleSelectParams,
-} from './latest';
+export type { BenchmarkScore, Benchmark, GetBenchmarkResponse } from './latest';

x-pack/plugins/cloud_security_posture/common/types/latest.ts

@@ -5,5 +5,4 @@
  * 2.0.
  */
 
-export * from './rules/v5';
 export * from './benchmarks/v2';

x-pack/plugins/cloud_security_posture/common/types_old.ts

@@ -5,7 +5,7 @@
  * 2.0.
  */
 import { type TypeOf } from '@kbn/config-schema';
-import type { CspBenchmarkRuleMetadata } from '@kbn/cloud-security-posture-common';
+import type { CspBenchmarkRuleMetadata } from '@kbn/cloud-security-posture-common/schema/rules/latest';
 import type { CspFinding } from '@kbn/cloud-security-posture-common';
 import { SUPPORTED_CLOUDBEAT_INPUTS, SUPPORTED_POLICY_TEMPLATES } from './constants';
 

x-pack/plugins/cloud_security_posture/common/utils/detection_rules.test.ts

@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import type { CspBenchmarkRuleMetadata } from '@kbn/cloud-security-posture-common';
+import type { CspBenchmarkRuleMetadata } from '@kbn/cloud-security-posture-common/schema/rules/latest';
 import {
   convertRuleTagsToMatchAllKQL,
   convertRuleTagsToMatchAnyKQL,

x-pack/plugins/cloud_security_posture/common/utils/detection_rules.ts

@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import type { CspBenchmarkRuleMetadata } from '@kbn/cloud-security-posture-common';
+import type { CspBenchmarkRuleMetadata } from '@kbn/cloud-security-posture-common/schema/rules/latest';
 
 const CSP_RULE_TAG = 'Cloud Security';
 const CSP_RULE_TAG_USE_CASE = 'Use Case: Configuration Audit';