[Security Solution][Exceptions] - Initial updates to exceptions viewer UX

x-pack/plugins/security_solution/common/detection_engine/schemas/request/find_exception_list_references_schema.test.ts

@@ -0,0 +1,90 @@
+/*
+ * 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 { exactCheck, formatErrors, foldLeftRight } from '@kbn/securitysolution-io-ts-utils';
+import { findExceptionReferencesOnRuleSchema } from './find_exception_list_references_schema';
+import type { FindExceptionReferencesOnRuleSchema } from './find_exception_list_references_schema';
+
+describe('find_exception_list_references_schema', () => {
+  test('validates all fields', () => {
+    const payload: FindExceptionReferencesOnRuleSchema = {
+      ids: 'abc,def',
+      list_ids: '123,456',
+      namespace_types: 'single,agnostic',
+    };
+
+    const decoded = findExceptionReferencesOnRuleSchema.decode(payload);
+    const checked = exactCheck(payload, decoded);
+    const output = foldLeftRight(checked);
+    expect(formatErrors(output.errors)).toEqual([]);
+    expect(output.schema).toEqual({
+      ids: ['abc', 'def'],
+      list_ids: ['123', '456'],
+      namespace_types: ['single', 'agnostic'],
+    });
+  });
+
+  test('"ids" cannot be undefined', () => {
+    const payload: Omit<FindExceptionReferencesOnRuleSchema, 'ids'> = {
+      list_ids: '123,456',
+      namespace_types: 'single,agnostic',
+    };
+
+    const decoded = findExceptionReferencesOnRuleSchema.decode(payload);
+    const checked = exactCheck(payload, decoded);
+    const output = foldLeftRight(checked);
+    expect(formatErrors(output.errors)).toEqual(['Invalid value "undefined" supplied to "ids"']);
+    expect(output.schema).toEqual({});
+  });
+
+  test('"list_ids" cannot be undefined', () => {
+    const payload: Omit<FindExceptionReferencesOnRuleSchema, 'list_ids'> = {
+      ids: 'abc',
+      namespace_types: 'single',
+    };
+
+    const decoded = findExceptionReferencesOnRuleSchema.decode(payload);
+    const checked = exactCheck(payload, decoded);
+    const output = foldLeftRight(checked);
+    expect(formatErrors(output.errors)).toEqual([
+      'Invalid value "undefined" supplied to "list_ids"',
+    ]);
+    expect(output.schema).toEqual({});
+  });
+
+  test('defaults "namespacetypes" to ["single"] if none set', () => {
+    const payload: Omit<FindExceptionReferencesOnRuleSchema, 'namespace_types'> = {
+      ids: 'abc',
+      list_ids: '123',
+    };
+
+    const decoded = findExceptionReferencesOnRuleSchema.decode(payload);
+    const checked = exactCheck(payload, decoded);
+    const output = foldLeftRight(checked);
+    expect(formatErrors(output.errors)).toEqual([]);
+    expect(output.schema).toEqual({
+      ids: ['abc'],
+      list_ids: ['123'],
+      namespace_types: ['single'],
+    });
+  });
+
+  test('cannot add extra values', () => {
+    const payload: FindExceptionReferencesOnRuleSchema & { extra_value?: string } = {
+      ids: 'abc,def',
+      list_ids: '123,456',
+      namespace_types: 'single,agnostic',
+      extra_value: 'aaa',
+    };
+
+    const decoded = findExceptionReferencesOnRuleSchema.decode(payload);
+    const checked = exactCheck(payload, decoded);
+    const output = foldLeftRight(checked);
+    expect(formatErrors(output.errors)).toEqual(['invalid keys "extra_value"']);
+    expect(output.schema).toEqual({});
+  });
+});

x-pack/plugins/security_solution/common/detection_engine/schemas/request/find_exception_list_references_schema.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 * as t from 'io-ts';
+import { NonEmptyStringArray } from '@kbn/securitysolution-io-ts-types';
+import { DefaultNamespaceArray } from '@kbn/securitysolution-io-ts-list-types';
+
+export const findExceptionReferencesOnRuleSchema = t.exact(
+  t.type({
+    ids: NonEmptyStringArray,
+    list_ids: NonEmptyStringArray,
+    namespace_types: DefaultNamespaceArray,
+  })
+);
+
+export type FindExceptionReferencesOnRuleSchema = t.OutputOf<
+  typeof findExceptionReferencesOnRuleSchema
+>;
+
+export type FindExceptionReferencesOnRuleSchemaDecoded = t.TypeOf<
+  typeof findExceptionReferencesOnRuleSchema
+>;

x-pack/plugins/security_solution/common/detection_engine/schemas/response/find_exception_list_references_schema.test.ts

@@ -0,0 +1,169 @@
+/*
+ * 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 { exactCheck, formatErrors, foldLeftRight } from '@kbn/securitysolution-io-ts-utils';
+import {
+  ruleReferenceSchema,
+  rulesReferencedByExceptionListsSchema,
+} from './find_exception_list_references_schema';
+import type {
+  RuleReferenceSchema,
+  RulesReferencedByExceptionListsSchema,
+} from './find_exception_list_references_schema';
+
+describe('find_exception_list_references_schema', () => {
+  describe('ruleReferenceSchema', () => {
+    test('validates all fields', () => {
+      const payload: RuleReferenceSchema = {
+        name: 'My rule',
+        id: '4656dc92-5832-11ea-8e2d-0242ac130003',
+        rule_id: 'my-rule-id',
+        exception_lists: [
+          {
+            id: 'myListId',
+            list_id: 'my-list-id',
+            namespace_type: 'single',
+            type: 'detection',
+          },
+        ],
+      };
+
+      const decoded = ruleReferenceSchema.decode(payload);
+      const checked = exactCheck(payload, decoded);
+      const output = foldLeftRight(checked);
+      expect(formatErrors(output.errors)).toEqual([]);
+      expect(output.schema).toEqual({
+        exception_lists: [
+          { id: 'myListId', list_id: 'my-list-id', namespace_type: 'single', type: 'detection' },
+        ],
+        id: '4656dc92-5832-11ea-8e2d-0242ac130003',
+        name: 'My rule',
+        rule_id: 'my-rule-id',
+      });
+    });
+
+    test('cannot add extra values', () => {
+      const payload: RuleReferenceSchema & { extra_value?: string } = {
+        name: 'My rule',
+        id: '4656dc92-5832-11ea-8e2d-0242ac130003',
+        rule_id: 'my-rule-id',
+        extra_value: 'foo',
+        exception_lists: [
+          {
+            id: 'myListId',
+            list_id: 'my-list-id',
+            namespace_type: 'single',
+            type: 'detection',
+          },
+        ],
+      };
+
+      const decoded = ruleReferenceSchema.decode(payload);
+      const checked = exactCheck(payload, decoded);
+      const output = foldLeftRight(checked);
+      expect(formatErrors(output.errors)).toEqual(['invalid keys "extra_value"']);
+      expect(output.schema).toEqual({});
+    });
+  });
+
+  describe('rulesReferencedByExceptionListsSchema', () => {
+    test('validates all fields', () => {
+      const payload: RulesReferencedByExceptionListsSchema = {
+        references: [
+          {
+            'my-list-id': [
+              {
+                name: 'My rule',
+                id: '4656dc92-5832-11ea-8e2d-0242ac130003',
+                rule_id: 'my-rule-id',
+                exception_lists: [
+                  {
+                    id: 'myListId',
+                    list_id: 'my-list-id',
+                    namespace_type: 'single',
+                    type: 'detection',
+                  },
+                ],
+              },
+            ],
+          },
+        ],
+      };
+
+      const decoded = rulesReferencedByExceptionListsSchema.decode(payload);
+      const checked = exactCheck(payload, decoded);
+      const output = foldLeftRight(checked);
+      expect(formatErrors(output.errors)).toEqual([]);
+      expect(output.schema).toEqual({
+        references: [
+          {
+            'my-list-id': [
+              {
+                exception_lists: [
+                  {
+                    id: 'myListId',
+                    list_id: 'my-list-id',
+                    namespace_type: 'single',
+                    type: 'detection',
+                  },
+                ],
+                id: '4656dc92-5832-11ea-8e2d-0242ac130003',
+                name: 'My rule',
+                rule_id: 'my-rule-id',
+              },
+            ],
+          },
+        ],
+      });
+    });
+
+    test('validates "references" with empty array', () => {
+      const payload: RulesReferencedByExceptionListsSchema = {
+        references: [],
+      };
+
+      const decoded = rulesReferencedByExceptionListsSchema.decode(payload);
+      const checked = exactCheck(payload, decoded);
+      const output = foldLeftRight(checked);
+      expect(formatErrors(output.errors)).toEqual([]);
+      expect(output.schema).toEqual({
+        references: [],
+      });
+    });
+
+    test('cannot add extra values', () => {
+      const payload: RulesReferencedByExceptionListsSchema & { extra_value?: string } = {
+        extra_value: 'foo',
+        references: [
+          {
+            'my-list-id': [
+              {
+                name: 'My rule',
+                id: '4656dc92-5832-11ea-8e2d-0242ac130003',
+                rule_id: 'my-rule-id',
+                exception_lists: [
+                  {
+                    id: 'myListId',
+                    list_id: 'my-list-id',
+                    namespace_type: 'single',
+                    type: 'detection',
+                  },
+                ],
+              },
+            ],
+          },
+        ],
+      };
+
+      const decoded = rulesReferencedByExceptionListsSchema.decode(payload);
+      const checked = exactCheck(payload, decoded);
+      const output = foldLeftRight(checked);
+      expect(formatErrors(output.errors)).toEqual(['invalid keys "extra_value"']);
+      expect(output.schema).toEqual({});
+    });
+  });
+});

x-pack/plugins/security_solution/common/detection_engine/schemas/response/find_exception_list_references_schema.ts

@@ -0,0 +1,37 @@
+/*
+ * 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 * as t from 'io-ts';
+
+import { listArray, list_id } from '@kbn/securitysolution-io-ts-list-types';
+
+import { rule_id, id, name } from '../common/schemas';
+
+export const ruleReferenceSchema = t.exact(
+  t.type({
+    name,
+    id,
+    rule_id,
+    exception_lists: listArray,
+  })
+);
+
+export type RuleReferenceSchema = t.OutputOf<typeof ruleReferenceSchema>;
+
+export const rulesReferencedByExceptionListSchema = t.record(list_id, t.array(ruleReferenceSchema));
+
+export type RuleReferencesSchema = t.OutputOf<typeof rulesReferencedByExceptionListSchema>;
+
+export const rulesReferencedByExceptionListsSchema = t.exact(
+  t.type({
+    references: t.array(rulesReferencedByExceptionListSchema),
+  })
+);
+
+export type RulesReferencedByExceptionListsSchema = t.OutputOf<
+  typeof rulesReferencedByExceptionListsSchema
+>;

x-pack/plugins/security_solution/common/detection_engine/schemas/response/index.ts

@@ -7,6 +7,7 @@
 
 export * from './error_schema';
 export * from './get_installed_integrations_response_schema';
+export * from './find_exception_list_references_schema';
 export * from './import_rules_schema';
 export * from './prepackaged_rules_schema';
 export * from './prepackaged_rules_status_schema';