[7.x] [SIEM][CASE] Dynamic fields mapping based on connector (#64412) (…

…#65266)
elastic · May 5, 2020 · f42c7ea · f42c7ea
1 parent aeb2a06
commit f42c7ea
Show file tree

Hide file tree

Showing 34 changed files with 661 additions and 238 deletions.
diff --git a/x-pack/plugins/case/common/api/cases/configure.ts b/x-pack/plugins/case/common/api/cases/configure.ts
@@ -8,10 +8,12 @@ import * as rt from 'io-ts';
 
 import { ActionResult } from '../../../../actions/common';
 import { UserRT } from '../user';
+import { JiraFieldsRT } from '../connectors/jira';
+import { ServiceNowFieldsRT } from '../connectors/servicenow';
 
 /*
  * This types below are related to the service now configuration
- * mapping between our case and service-now
+ * mapping between our case and [service-now, jira]
  *
  */
 
@@ -27,12 +29,7 @@ const CaseFieldRT = rt.union([
   rt.literal('comments'),
 ]);
 
-const ThirdPartyFieldRT = rt.union([
-  rt.literal('comments'),
-  rt.literal('description'),
-  rt.literal('not_mapped'),
-  rt.literal('short_description'),
-]);
+const ThirdPartyFieldRT = rt.union([JiraFieldsRT, ServiceNowFieldsRT, rt.literal('not_mapped')]);
 
 export const CasesConfigurationMapsRT = rt.type({
   source: CaseFieldRT,

diff --git a/x-pack/plugins/case/common/api/connectors/index.ts b/x-pack/plugins/case/common/api/connectors/index.ts
@@ -0,0 +1,8 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export * from './jira';
+export * from './servicenow';
diff --git a/x-pack/plugins/case/common/api/connectors/jira.ts b/x-pack/plugins/case/common/api/connectors/jira.ts
@@ -0,0 +1,15 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import * as rt from 'io-ts';
+
+export const JiraFieldsRT = rt.union([
+  rt.literal('summary'),
+  rt.literal('description'),
+  rt.literal('comments'),
+]);
+
+export type JiraFieldsType = rt.TypeOf<typeof JiraFieldsRT>;
diff --git a/x-pack/plugins/case/common/api/connectors/servicenow.ts b/x-pack/plugins/case/common/api/connectors/servicenow.ts
@@ -0,0 +1,15 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import * as rt from 'io-ts';
+
+export const ServiceNowFieldsRT = rt.union([
+  rt.literal('short_description'),
+  rt.literal('description'),
+  rt.literal('comments'),
+]);
+
+export type ServiceNowFieldsType = rt.TypeOf<typeof ServiceNowFieldsRT>;
diff --git a/x-pack/plugins/siem/public/containers/case/configure/mock.ts b/x-pack/plugins/siem/public/containers/case/configure/mock.ts
@@ -30,7 +30,7 @@ export const mapping: CasesConfigurationMapping[] = [
 ];
 export const connectorsMock: Connector[] = [
   {
-    id: '123',
+    id: 'servicenow-1',
     actionTypeId: '.servicenow',
     name: 'My Connector',
     config: {
@@ -42,7 +42,7 @@ export const connectorsMock: Connector[] = [
     isPreconfigured: false,
   },
   {
-    id: '456',
+    id: 'servicenow-2',
     actionTypeId: '.servicenow',
     name: 'My Connector 2',
     config: {
@@ -69,6 +69,34 @@ export const connectorsMock: Connector[] = [
     },
     isPreconfigured: false,
   },
+  {
+    id: 'jira-1',
+    actionTypeId: '.jira',
+    name: 'Jira',
+    config: {
+      apiUrl: 'https://instance.atlassian.ne',
+      casesConfiguration: {
+        mapping: [
+          {
+            source: 'title',
+            target: 'summary',
+            actionType: 'overwrite',
+          },
+          {
+            source: 'description',
+            target: 'description',
+            actionType: 'overwrite',
+          },
+          {
+            source: 'comments',
+            target: 'comments',
+            actionType: 'append',
+          },
+        ],
+      },
+    },
+    isPreconfigured: false,
+  },
 ];
 
 export const caseConfigurationResposeMock: CasesConfigureResponse = {

diff --git a/x-pack/plugins/siem/public/lib/connectors/components/connector_flyout/index.tsx b/x-pack/plugins/siem/public/lib/connectors/components/connector_flyout/index.tsx
@@ -13,14 +13,16 @@ import { isEmpty, get } from 'lodash/fp';
 import { ActionConnectorFieldsProps } from '../../../../../../triggers_actions_ui/public/types';
 import { FieldMapping } from '../../../../pages/case/components/configure_cases/field_mapping';
 
-import { defaultMapping } from '../../config';
 import { CasesConfigurationMapping } from '../../../../containers/case/configure/types';
 
 import * as i18n from '../../translations';
 import { ActionConnector, ConnectorFlyoutHOCProps } from '../../types';
+import { createDefaultMapping } from '../../utils';
+import { connectorsConfiguration } from '../../config';
 
 export const withConnectorFlyout = <T extends ActionConnector>({
   ConnectorFormComponent,
+  connectorActionTypeId,
   secretKeys = [],
   configKeys = [],
 }: ConnectorFlyoutHOCProps<T>) => {
@@ -56,7 +58,7 @@ export const withConnectorFlyout = <T extends ActionConnector>({
     if (isEmpty(mapping)) {
       editActionConfig('casesConfiguration', {
         ...action.config.casesConfiguration,
-        mapping: defaultMapping,
+        mapping: createDefaultMapping(connectorsConfiguration[connectorActionTypeId].fields),
       });
     }
 
@@ -135,6 +137,7 @@ export const withConnectorFlyout = <T extends ActionConnector>({
           <EuiFlexItem>
             <FieldMapping
               disabled={true}
+              connectorActionTypeId={connectorActionTypeId}
               mapping={mapping as CasesConfigurationMapping[]}
               onChangeMapping={handleOnChangeMappingConfig}
             />

diff --git a/x-pack/plugins/siem/public/lib/connectors/config.ts b/x-pack/plugins/siem/public/lib/connectors/config.ts
@@ -4,31 +4,11 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { CasesConfigurationMapping } from '../../containers/case/configure/types';
-
-import { Connector } from './types';
 import { connector as serviceNowConnectorConfig } from './servicenow/config';
 import { connector as jiraConnectorConfig } from './jira/config';
+import { ConnectorConfiguration } from './types';
 
-export const connectorsConfiguration: Record<string, Connector> = {
+export const connectorsConfiguration: Record<string, ConnectorConfiguration> = {
   '.servicenow': serviceNowConnectorConfig,
   '.jira': jiraConnectorConfig,
 };
-
-export const defaultMapping: CasesConfigurationMapping[] = [
-  {
-    source: 'title',
-    target: 'short_description',
-    actionType: 'overwrite',
-  },
-  {
-    source: 'description',
-    target: 'description',
-    actionType: 'overwrite',
-  },
-  {
-    source: 'comments',
-    target: 'comments',
-    actionType: 'append',
-  },
-];
diff --git a/x-pack/plugins/siem/public/lib/connectors/jira/config.ts b/x-pack/plugins/siem/public/lib/connectors/jira/config.ts
@@ -4,17 +4,37 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { Connector } from '../types';
+import { ConnectorConfiguration } from './types';
 
-import { JIRA_TITLE } from './translations';
+import * as i18n from './translations';
 import logo from './logo.svg';
 
-export const connector: Connector = {
+export const connector: ConnectorConfiguration = {
   id: '.jira',
-  name: JIRA_TITLE,
+  name: i18n.JIRA_TITLE,
   logo,
   enabled: true,
   enabledInConfig: true,
   enabledInLicense: true,
   minimumLicenseRequired: 'platinum',
+  fields: {
+    summary: {
+      label: i18n.MAPPING_FIELD_SUMMARY,
+      validSourceFields: ['title', 'description'],
+      defaultSourceField: 'title',
+      defaultActionType: 'overwrite',
+    },
+    description: {
+      label: i18n.MAPPING_FIELD_DESC,
+      validSourceFields: ['title', 'description'],
+      defaultSourceField: 'description',
+      defaultActionType: 'overwrite',
+    },
+    comments: {
+      label: i18n.MAPPING_FIELD_COMMENTS,
+      validSourceFields: ['comments'],
+      defaultSourceField: 'comments',
+      defaultActionType: 'append',
+    },
+  },
 };
diff --git a/x-pack/plugins/siem/public/lib/connectors/jira/flyout.tsx b/x-pack/plugins/siem/public/lib/connectors/jira/flyout.tsx
@@ -107,4 +107,5 @@ export const JiraConnectorFlyout = withConnectorFlyout<JiraActionConnector>({
   ConnectorFormComponent: JiraConnectorForm,
   secretKeys: ['email', 'apiToken'],
   configKeys: ['projectKey'],
+  connectorActionTypeId: '.jira',
 });
diff --git a/x-pack/plugins/siem/public/lib/connectors/jira/logo.svg b/x-pack/plugins/siem/public/lib/connectors/jira/logo.svg
diff --git a/x-pack/plugins/siem/public/lib/connectors/jira/translations.ts b/x-pack/plugins/siem/public/lib/connectors/jira/translations.ts
@@ -26,3 +26,10 @@ export const JIRA_PROJECT_KEY_REQUIRED = i18n.translate(
     defaultMessage: 'Project key is required',
   }
 );
+
+export const MAPPING_FIELD_SUMMARY = i18n.translate(
+  'xpack.siem.case.configureCases.mappingFieldSummary',
+  {
+    defaultMessage: 'Summary',
+  }
+);
diff --git a/x-pack/plugins/siem/public/lib/connectors/jira/types.ts b/x-pack/plugins/siem/public/lib/connectors/jira/types.ts
@@ -12,6 +12,10 @@ import {
   JiraSecretConfigurationType,
 } from '../../../../../actions/server/builtin_action_types/jira/types';
 
+export { JiraFieldsType } from '../../../../../case/common/api/connectors';
+
+export * from '../types';
+
 export interface JiraActionConnector {
   config: JiraPublicConfigurationType;
   secrets: JiraSecretConfigurationType;

diff --git a/x-pack/plugins/siem/public/lib/connectors/servicenow/config.ts b/x-pack/plugins/siem/public/lib/connectors/servicenow/config.ts
@@ -4,17 +4,36 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { Connector } from '../types';
-
-import { SERVICENOW_TITLE } from './translations';
+import { ConnectorConfiguration } from './types';
+import * as i18n from './translations';
 import logo from './logo.svg';
 
-export const connector: Connector = {
+export const connector: ConnectorConfiguration = {
   id: '.servicenow',
-  name: SERVICENOW_TITLE,
+  name: i18n.SERVICENOW_TITLE,
   logo,
   enabled: true,
   enabledInConfig: true,
   enabledInLicense: true,
   minimumLicenseRequired: 'platinum',
+  fields: {
+    short_description: {
+      label: i18n.MAPPING_FIELD_SHORT_DESC,
+      validSourceFields: ['title', 'description'],
+      defaultSourceField: 'title',
+      defaultActionType: 'overwrite',
+    },
+    description: {
+      label: i18n.MAPPING_FIELD_DESC,
+      validSourceFields: ['title', 'description'],
+      defaultSourceField: 'description',
+      defaultActionType: 'overwrite',
+    },
+    comments: {
+      label: i18n.MAPPING_FIELD_COMMENTS,
+      validSourceFields: ['comments'],
+      defaultSourceField: 'comments',
+      defaultActionType: 'append',
+    },
+  },
 };
diff --git a/x-pack/plugins/siem/public/lib/connectors/servicenow/flyout.tsx b/x-pack/plugins/siem/public/lib/connectors/servicenow/flyout.tsx
@@ -80,4 +80,5 @@ const ServiceNowConnectorForm: React.FC<ConnectorFlyoutFormProps<ServiceNowActio
 export const ServiceNowConnectorFlyout = withConnectorFlyout<ServiceNowActionConnector>({
   ConnectorFormComponent: ServiceNowConnectorForm,
   secretKeys: ['username', 'password'],
+  connectorActionTypeId: '.servicenow',
 });
diff --git a/x-pack/plugins/siem/public/lib/connectors/servicenow/translations.ts b/x-pack/plugins/siem/public/lib/connectors/servicenow/translations.ts
@@ -21,3 +21,10 @@ export const SERVICENOW_TITLE = i18n.translate(
     defaultMessage: 'ServiceNow',
   }
 );
+
+export const MAPPING_FIELD_SHORT_DESC = i18n.translate(
+  'xpack.siem.case.configureCases.mappingFieldShortDescription',
+  {
+    defaultMessage: 'Short Description',
+  }
+);
diff --git a/x-pack/plugins/siem/public/lib/connectors/servicenow/types.ts b/x-pack/plugins/siem/public/lib/connectors/servicenow/types.ts
@@ -12,6 +12,10 @@ import {
   ServiceNowSecretConfigurationType,
 } from '../../../../../actions/server/builtin_action_types/servicenow/types';
 
+export { ServiceNowFieldsType } from '../../../../../case/common/api/connectors';
+
+export * from '../types';
+
 export interface ServiceNowActionConnector {
   config: ServiceNowPublicConfigurationType;
   secrets: ServiceNowSecretConfigurationType;

diff --git a/x-pack/plugins/siem/public/lib/connectors/translations.ts b/x-pack/plugins/siem/public/lib/connectors/translations.ts
@@ -79,3 +79,17 @@ export const EMAIL_REQUIRED = i18n.translate(
     defaultMessage: 'Email is required',
   }
 );
+
+export const MAPPING_FIELD_DESC = i18n.translate(
+  'xpack.siem.case.configureCases.mappingFieldDescription',
+  {
+    defaultMessage: 'Description',
+  }
+);
+
+export const MAPPING_FIELD_COMMENTS = i18n.translate(
+  'xpack.siem.case.configureCases.mappingFieldComments',
+  {
+    defaultMessage: 'Comments',
+  }
+);
diff --git a/x-pack/plugins/siem/public/lib/connectors/types.ts b/x-pack/plugins/siem/public/lib/connectors/types.ts
@@ -10,8 +10,20 @@
 import { ActionType } from '../../../../triggers_actions_ui/public';
 import { ExternalIncidentServiceConfiguration } from '../../../../actions/server/builtin_action_types/case/types';
 
-export interface Connector extends ActionType {
+import { ActionType as ThirdPartySupportedActions, CaseField } from '../../../../case/common/api';
+
+export { ThirdPartyField as AllThirdPartyFields } from '../../../../case/common/api';
+
+export interface ThirdPartyField {
+  label: string;
+  validSourceFields: CaseField[];
+  defaultSourceField: CaseField;
+  defaultActionType: ThirdPartySupportedActions;
+}
+
+export interface ConnectorConfiguration extends ActionType {
   logo: string;
+  fields: Record<string, ThirdPartyField>;
 }
 
 export interface ActionConnector {
@@ -40,6 +52,7 @@ export interface ConnectorFlyoutFormProps<T> {
 
 export interface ConnectorFlyoutHOCProps<T> {
   ConnectorFormComponent: React.FC<ConnectorFlyoutFormProps<T>>;
+  connectorActionTypeId: string;
   configKeys?: string[];
   secretKeys?: string[];
 }