[Cases] Integrating file service and registering file kinds

x-pack/plugins/cases/common/constants/application.ts

@@ -0,0 +1,31 @@
+/*
+ * 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 { CASE_VIEW_PAGE_TABS } from '../types';
+
+/**
+ * Application
+ */
+
+export const APP_ID = 'cases' as const;
+export const FEATURE_ID = 'generalCases' as const;
+export const APP_OWNER = 'cases' as const;
+export const APP_PATH = '/app/management/insightsAndAlerting/cases' as const;
+export const CASES_CREATE_PATH = '/create' as const;
+export const CASES_CONFIGURE_PATH = '/configure' as const;
+export const CASE_VIEW_PATH = '/:detailName' as const;
+export const CASE_VIEW_COMMENT_PATH = `${CASE_VIEW_PATH}/:commentId` as const;
+export const CASE_VIEW_ALERT_TABLE_PATH =
+  `${CASE_VIEW_PATH}/?tabId=${CASE_VIEW_PAGE_TABS.ALERTS}` as const;
+export const CASE_VIEW_TAB_PATH = `${CASE_VIEW_PATH}/?tabId=:tabId` as const;
+
+/**
+ * The main Cases application is in the stack management under the
+ * Alerts and Insights section. To do that, Cases registers to the management
+ * application. This constant holds the application ID of the management plugin
+ */
+export const STACK_APP_ID = 'management' as const;

x-pack/plugins/cases/common/constants/files.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 type { FileKind } from '@kbn/files-plugin/common';
+import { APP_ID } from './application';
+import { OBSERVABILITY_OWNER, SECURITY_SOLUTION_OWNER } from './owners';
+import { Operation } from './types';
+import type { Owner } from './types';
+import { ALLOWED_MIME_TYPES } from './mime_types';
+
+const buildFileKind = (owner: Owner): FileKind => {
+  return {
+    id: owner,
+    http: fileKindHttpTags(owner),
+    maxSizeBytes: maxFileSize,
+    allowedMimeTypes: ALLOWED_MIME_TYPES,
+  };
+};
+
+const fileKindHttpTags = (owner: Owner) => {
+  return {
+    create: buildTag(owner, Operation.Create),
+    delete: buildTag(owner, Operation.Delete),
+    download: buildTag(owner, Operation.Read),
+    getById: buildTag(owner, Operation.Read),
+    list: buildTag(owner, Operation.Read),
+    update: buildTag(owner, Operation.Update),
+  };
+};
+
+const access = 'access:';
+
+const buildTag = (owner: Owner, operation: Operation) => {
+  return {
+    tags: [`${access}${constructHttpOperationTag(owner, operation)}`],
+  };
+};
+
+const maxFileSize = 100 * 1024 * 1024; // 100 MiB
+
+export const constructHttpOperationTag = (owner: Owner, operation: Operation) => {
+  return `${owner}FilesCases${operation}`;
+};
+
+/**
+ * The file kind definition for interacting with the file service
+ */
+export const CASES_FILE_KINDS: Record<Owner, FileKind> = {
+  [APP_ID]: buildFileKind(APP_ID),
+  [SECURITY_SOLUTION_OWNER]: buildFileKind(SECURITY_SOLUTION_OWNER),
+  [OBSERVABILITY_OWNER]: buildFileKind(OBSERVABILITY_OWNER),
+};

x-pack/plugins/cases/common/constants.ts → x-pack/plugins/cases/common/constants/index.ts

@@ -4,34 +4,15 @@
  * 2.0; you may not use this file except in compliance with the Elastic License
  * 2.0.
  */
-import { CASE_VIEW_PAGE_TABS } from './types';
-import type { CasesFeaturesAllRequired } from './ui/types';
 
-export const DEFAULT_DATE_FORMAT = 'dateFormat' as const;
-export const DEFAULT_DATE_FORMAT_TZ = 'dateFormat:tz' as const;
-
-/**
- * Application
- */
+import type { CasesFeaturesAllRequired } from '../ui/types';
 
-export const APP_ID = 'cases' as const;
-export const FEATURE_ID = 'generalCases' as const;
-export const APP_OWNER = 'cases' as const;
-export const APP_PATH = '/app/management/insightsAndAlerting/cases' as const;
-export const CASES_CREATE_PATH = '/create' as const;
-export const CASES_CONFIGURE_PATH = '/configure' as const;
-export const CASE_VIEW_PATH = '/:detailName' as const;
-export const CASE_VIEW_COMMENT_PATH = `${CASE_VIEW_PATH}/:commentId` as const;
-export const CASE_VIEW_ALERT_TABLE_PATH =
-  `${CASE_VIEW_PATH}/?tabId=${CASE_VIEW_PAGE_TABS.ALERTS}` as const;
-export const CASE_VIEW_TAB_PATH = `${CASE_VIEW_PATH}/?tabId=:tabId` as const;
+export * from './owners';
+export * from './files';
+export * from './application';
 
-/**
- * The main Cases application is in the stack management under the
- * Alerts and Insights section. To do that, Cases registers to the management
- * application. This constant holds the application ID of the management plugin
- */
-export const STACK_APP_ID = 'management' as const;
+export const DEFAULT_DATE_FORMAT = 'dateFormat' as const;
+export const DEFAULT_DATE_FORMAT_TZ = 'dateFormat:tz' as const;
 
 /**
  * Saved objects
@@ -111,37 +92,6 @@ export const CONNECTORS_URL = `${ACTION_URL}/connectors` as const;
  */
 export const MAX_ALERTS_PER_CASE = 1000 as const;
 
-/**
- * Owner
- */
-export const SECURITY_SOLUTION_OWNER = 'securitySolution' as const;
-export const OBSERVABILITY_OWNER = 'observability' as const;
-export const GENERAL_CASES_OWNER = APP_ID;
-
-export const OWNER_INFO = {
-  [SECURITY_SOLUTION_OWNER]: {
-    id: SECURITY_SOLUTION_OWNER,
-    appId: 'securitySolutionUI',
-    label: 'Security',
-    iconType: 'logoSecurity',
-    appRoute: '/app/security',
-  },
-  [OBSERVABILITY_OWNER]: {
-    id: OBSERVABILITY_OWNER,
-    appId: 'observability-overview',
-    label: 'Observability',
-    iconType: 'logoObservability',
-    appRoute: '/app/observability',
-  },
-  [GENERAL_CASES_OWNER]: {
-    id: GENERAL_CASES_OWNER,
-    appId: 'management',
-    label: 'Stack',
-    iconType: 'casesApp',
-    appRoute: '/app/management/insightsAndAlerting',
-  },
-} as const;
-
 /**
  * Searching
  */
@@ -186,6 +136,20 @@ export const UPDATE_CASES_CAPABILITY = 'update_cases' as const;
 export const DELETE_CASES_CAPABILITY = 'delete_cases' as const;
 export const PUSH_CASES_CAPABILITY = 'push_cases' as const;
 
+/**
+ * Cases API Tags
+ */
+
+/**
+ * This tag registered for the cases suggest user profiles API
+ */
+export const SUGGEST_USER_PROFILES_API_TAG = 'casesSuggestUserProfiles';
+
+/**
+ * This tag is registered for the security bulk get API
+ */
+export const BULK_GET_USER_PROFILES_API_TAG = 'bulkGetUserProfiles';
+
 /**
  * User profiles
  */

x-pack/plugins/cases/common/constants/mime_types.ts

@@ -0,0 +1,108 @@
+/*
+ * 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.
+ */
+
+/**
+ * These were retrieved from https://www.iana.org/assignments/media-types/media-types.xhtml#image
+ */
+const imageMimeTypes = [
+  'image/aces',
+  'image/apng',
+  'image/avci',
+  'image/avcs',
+  'image/avif',
+  'image/bmp',
+  'image/cgm',
+  'image/dicom-rle',
+  'image/dpx',
+  'image/emf',
+  'image/example',
+  'image/fits',
+  'image/g3fax',
+  'image/heic',
+  'image/heic-sequence',
+  'image/heif',
+  'image/heif-sequence',
+  'image/hej2k',
+  'image/hsj2',
+  'image/jls',
+  'image/jp2',
+  'image/jph',
+  'image/jphc',
+  'image/jpm',
+  'image/jpx',
+  'image/jxr',
+  'image/jxrA',
+  'image/jxrS',
+  'image/jxs',
+  'image/jxsc',
+  'image/jxsi',
+  'image/jxss',
+  'image/ktx',
+  'image/ktx2',
+  'image/naplps',
+  'image/png',
+  'image/prs.btif',
+  'image/prs.pti',
+  'image/pwg-raster',
+  'image/svg+xml',
+  'image/t38',
+  'image/tiff',
+  'image/tiff-fx',
+  'image/vnd.adobe.photoshop',
+  'image/vnd.airzip.accelerator.azv',
+  'image/vnd.cns.inf2',
+  'image/vnd.dece.graphic',
+  'image/vnd.djvu',
+  'image/vnd.dwg',
+  'image/vnd.dxf',
+  'image/vnd.dvb.subtitle',
+  'image/vnd.fastbidsheet',
+  'image/vnd.fpx',
+  'image/vnd.fst',
+  'image/vnd.fujixerox.edmics-mmr',
+  'image/vnd.fujixerox.edmics-rlc',
+  'image/vnd.globalgraphics.pgb',
+  'image/vnd.microsoft.icon',
+  'image/vnd.mix',
+  'image/vnd.ms-modi',
+  'image/vnd.mozilla.apng',
+  'image/vnd.net-fpx',
+  'image/vnd.pco.b16',
+  'image/vnd.radiance',
+  'image/vnd.sealed.png',
+  'image/vnd.sealedmedia.softseal.gif',
+  'image/vnd.sealedmedia.softseal.jpg',
+  'image/vnd.svf',
+  'image/vnd.tencent.tap',
+  'image/vnd.valve.source.texture',
+  'image/vnd.wap.wbmp',
+  'image/vnd.xiff',
+  'image/vnd.zbrush.pcx',
+  'image/webp',
+  'image/wmf',
+  'image/emf',
+];
+
+const textMimeTypes = ['text/plain', 'text/csv', 'text/json', 'application/json'];
+
+const compressionMimeTypes = [
+  'application/zip',
+  'application/gzip',
+  'application/x-bzip',
+  'application/x-bzip2',
+  'application/x-7z-compressed',
+  'application/x-tar',
+];
+
+const pdfMimeTypes = ['application/pdf'];
+
+export const ALLOWED_MIME_TYPES = [
+  ...imageMimeTypes,
+  ...textMimeTypes,
+  ...compressionMimeTypes,
+  ...pdfMimeTypes,
+];

x-pack/plugins/cases/common/constants/owners.ts

@@ -0,0 +1,50 @@
+/*
+ * 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 { APP_ID } from './application';
+import type { Owner } from './types';
+
+/**
+ * Owner
+ */
+export const SECURITY_SOLUTION_OWNER = 'securitySolution' as const;
+export const OBSERVABILITY_OWNER = 'observability' as const;
+export const GENERAL_CASES_OWNER = APP_ID;
+
+export const OWNERS = [SECURITY_SOLUTION_OWNER, OBSERVABILITY_OWNER, GENERAL_CASES_OWNER] as const;
+
+interface RouteInfo {
+  id: Owner;
+  appId: string;
+  label: string;
+  iconType: string;
+  appRoute: string;
+}
+
+export const OWNER_INFO: Record<Owner, RouteInfo> = {
+  [SECURITY_SOLUTION_OWNER]: {
+    id: SECURITY_SOLUTION_OWNER,
+    appId: 'securitySolutionUI',
+    label: 'Security',
+    iconType: 'logoSecurity',
+    appRoute: '/app/security',
+  },
+  [OBSERVABILITY_OWNER]: {
+    id: OBSERVABILITY_OWNER,
+    appId: 'observability-overview',
+    label: 'Observability',
+    iconType: 'logoObservability',
+    appRoute: '/app/observability',
+  },
+  [GENERAL_CASES_OWNER]: {
+    id: GENERAL_CASES_OWNER,
+    appId: 'management',
+    label: 'Stack',
+    iconType: 'casesApp',
+    appRoute: '/app/management/insightsAndAlerting',
+  },
+} as const;

x-pack/plugins/cases/common/constants/types.ts

@@ -0,0 +1,17 @@
+/*
+ * 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 { OWNERS } from './owners';
+
+export enum Operation {
+  Read = 'Read',
+  Create = 'Create',
+  Update = 'Update',
+  Delete = 'Delete',
+}
+
+export type Owner = typeof OWNERS[number];

x-pack/plugins/cases/common/index.ts

@@ -55,3 +55,4 @@ export { StatusAll } from './ui/types';
 
 export { getCreateConnectorUrl, getAllConnectorsUrl } from './utils/connectors_api';
 export { createUICapabilities } from './utils/capabilities';
+export { getApiTags } from './utils/api_tags';