[backend] ”Saved filters” module implemented (#6044)

Co-authored-by: Valentin Bouzin <[email protected]>

Author: CelineSebe

opencti-platform/opencti-front/src/schema/relay.schema.graphql

@@ -8206,6 +8206,7 @@ type Query {
   fintelTemplate(id: ID!): FintelTemplate
   disseminationList(id: ID!): DisseminationList
   disseminationLists(first: Int, after: ID, orderBy: DisseminationListOrdering, orderMode: OrderingMode, filters: FilterGroup, search: String): DisseminationListConnection
+  savedFilters(first: Int, after: ID, orderBy: SavedFilterOrdering, orderMode: OrderingMode, filters: FilterGroup, search: String): SavedFilterConnection
 }
 
 type Subscription {
@@ -9051,6 +9052,8 @@ type Mutation {
   disseminationListDelete(id: ID!): ID
   disseminationListFieldPatch(id: ID!, input: [EditInput!]!): DisseminationList
   disseminationListSend(id: ID!, input: DisseminationListSendInput!): Boolean
+  savedFilterAdd(input: SavedFilterAddInput!): SavedFilter
+  savedFilterDelete(id: ID!): ID
 }
 
 type Channel implements BasicObject & StixObject & StixCoreObject & StixDomainObject {
@@ -12668,4 +12671,35 @@ input DisseminationListSendInput {
   email_body: String!
   email_attachment_ids: [ID!]!
   html_to_body_file_id: ID
+}
+
+type SavedFilter implements InternalObject & BasicObject {
+  id: ID!
+  standard_id: String!
+  entity_type: String!
+  parent_types: [String]!
+  name: String!
+  filters: String!
+  scope: String
+}
+
+type SavedFilterEdge {
+  cursor: String!
+  node: SavedFilter!
+}
+
+type SavedFilterConnection {
+  pageInfo: PageInfo!
+  edges: [SavedFilterEdge!]
+}
+
+enum SavedFilterOrdering {
+  name
+  _score
+}
+
+input SavedFilterAddInput {
+  name: String!
+  filters: String!
+  scope: String
 }

opencti-platform/opencti-graphql/graphql-codegen.yml

@@ -55,6 +55,7 @@ generates:
         DraftWorkspace: ../modules/draftWorkspace/draftWorkspace-types#BasicStoreEntityDraftWorkspace
         ExclusionList: ../modules/exclusionList/exclusionList-types#BasicStoreEntityExclusionList
         FintelTemplate: ../modules/fintelTemplate/fintelTemplate-types#BasicStoreEntityFintelTemplate
+        SavedFilter: ../modules/savedFilter/savedFilter-types#BasicStoreEntitySavedFilter
   ./graphql.schema.json:
     plugins:
       - "introspection"

opencti-platform/opencti-graphql/src/generated/graphql.ts

@@ -66,6 +66,7 @@ import './exclusionList/exclusionList';
 import './draftWorkspace/draftWorkspace';
 import './fintelTemplate/fintelTemplate';
 import './disseminationList/disseminationList';
+import './savedFilter/savedFilter';
 
 // incomplete modules
 import './report/report';
@@ -127,4 +128,5 @@ import './exclusionList/exclusionList-graphql';
 import './draftWorkspace/draftWorkspace-graphql';
 import './fintelTemplate/fintelTemplate-graphql';
 import './disseminationList/disseminationList-graphql';
+import './savedFilter/savedFilter-graphql';
 // endregion

opencti-platform/opencti-graphql/src/modules/index.ts

@@ -0,0 +1,14 @@
+import type { StixSavedFilter, StoreEntitySavedFilter } from './savedFilter-types';
+import { buildStixObject } from '../../database/stix-converter';
+
+const convertSavedFiltersToStix = (instance: StoreEntitySavedFilter): StixSavedFilter => {
+  const stixObject = buildStixObject(instance);
+  return {
+    ...stixObject,
+    name: instance.name,
+    filters: instance.filters,
+    scope: instance.scope,
+  };
+};
+
+export default convertSavedFiltersToStix;

opencti-platform/opencti-graphql/src/modules/savedFilter/savedFilter-converter.ts

@@ -0,0 +1,18 @@
+import { addFilter } from '../../utils/filtering/filtering-utils';
+import { type BasicStoreEntitySavedFilter, ENTITY_TYPE_SAVED_FILTER, type StoreEntitySavedFilter } from './savedFilter-types';
+import type { AuthContext, AuthUser } from '../../types/user';
+import { listEntitiesPaginated } from '../../database/middleware-loader';
+import type { QuerySavedFiltersArgs, SavedFilterAddInput } from '../../generated/graphql';
+import { createInternalObject, deleteInternalObject } from '../../domain/internalObject';
+
+export const findAll = (context: AuthContext, user: AuthUser, args: QuerySavedFiltersArgs) => {
+  const queryFilters = addFilter(args.filters, 'creator_id', user.id);
+  const queryArgs = { ...args, filters: queryFilters };
+  return listEntitiesPaginated<BasicStoreEntitySavedFilter>(context, user, [ENTITY_TYPE_SAVED_FILTER], queryArgs);
+};
+export const addSavedFilter = (context: AuthContext, user: AuthUser, input: SavedFilterAddInput) => {
+  return createInternalObject<StoreEntitySavedFilter>(context, user, input, ENTITY_TYPE_SAVED_FILTER);
+};
+export const deleteSavedFilter = (context: AuthContext, user: AuthUser, savedFilterId: string) => {
+  return deleteInternalObject(context, user, savedFilterId, ENTITY_TYPE_SAVED_FILTER);
+};

opencti-platform/opencti-graphql/src/modules/savedFilter/savedFilter-domain.ts

@@ -0,0 +1,8 @@
+import { registerGraphqlSchema } from '../../graphql/schema';
+import savedFilterTypeDefs from './savedFilter.graphql';
+import savedFilterResolver from './savedFilter-resolver';
+
+registerGraphqlSchema({
+  schema: savedFilterTypeDefs,
+  resolver: savedFilterResolver
+});

opencti-platform/opencti-graphql/src/modules/savedFilter/savedFilter-graphql.ts

@@ -0,0 +1,18 @@
+import type { Resolvers } from '../../generated/graphql';
+import { addSavedFilter, deleteSavedFilter, findAll } from './savedFilter-domain';
+
+const savedFilterResolver: Resolvers = {
+  Query: {
+    savedFilters: (_, args, context) => findAll(context, context.user, args),
+  },
+  Mutation: {
+    savedFilterAdd: (_, { input }, context) => {
+      return addSavedFilter(context, context.user, input);
+    },
+    savedFilterDelete: (_, { id }, context) => {
+      return deleteSavedFilter(context, context.user, id);
+    },
+  },
+};
+
+export default savedFilterResolver;

opencti-platform/opencti-graphql/src/modules/savedFilter/savedFilter-resolver.ts

@@ -0,0 +1,22 @@
+import type { BasicStoreEntity, StoreEntity } from '../../types/store';
+import type { StixObject } from '../../types/stix-common';
+
+export const ENTITY_TYPE_SAVED_FILTER = 'SavedFilter';
+
+export interface BasicStoreEntitySavedFilter extends BasicStoreEntity {
+  name: string
+  filters: string
+  scope: string
+}
+
+export interface StoreEntitySavedFilter extends StoreEntity {
+  name: string
+  filters: string
+  scope: string
+}
+
+export interface StixSavedFilter extends StixObject {
+  name: string
+  filters: string
+  scope: string
+}

opencti-platform/opencti-graphql/src/modules/savedFilter/savedFilter-types.ts

@@ -0,0 +1,48 @@
+type SavedFilter implements InternalObject & BasicObject {
+    id: ID!
+    standard_id: String!
+    entity_type: String!
+    parent_types: [String]!
+    # SavedFilters
+    name: String!
+    filters: String!
+    scope: String
+}
+
+type SavedFilterEdge {
+    cursor: String!
+    node: SavedFilter!
+}
+
+type SavedFilterConnection {
+    pageInfo: PageInfo!
+    edges: [SavedFilterEdge!]
+}
+
+enum SavedFilterOrdering {
+    name
+    _score
+}
+
+input SavedFilterAddInput {
+    name: String!
+    filters: String!
+    scope: String
+}
+
+
+type Query {
+    savedFilters(
+        first: Int
+        after: ID
+        orderBy: SavedFilterOrdering
+        orderMode: OrderingMode
+        filters: FilterGroup
+        search: String
+    ): SavedFilterConnection @auth
+}
+
+type Mutation {
+    savedFilterAdd(input: SavedFilterAddInput!): SavedFilter @auth
+    savedFilterDelete(id: ID!): ID @auth
+}

opencti-platform/opencti-graphql/src/modules/savedFilter/savedFilter.graphql

@@ -0,0 +1,69 @@
+import { v4 as uuidv4 } from 'uuid';
+import convertSavedFiltersToStix from './savedFilter-converter';
+import { ENTITY_TYPE_SAVED_FILTER, type StoreEntitySavedFilter, type StixSavedFilter } from './savedFilter-types';
+import { ABSTRACT_INTERNAL_OBJECT } from '../../schema/general';
+import { type ModuleDefinition, registerDefinition } from '../../schema/module';
+import { isFeatureEnabled } from '../../config/conf';
+import { creators, createdAt } from '../../schema/attribute-definition';
+
+const SAVED_FILTER_DEFINITION: ModuleDefinition<StoreEntitySavedFilter, StixSavedFilter> = {
+  type: {
+    id: 'saved-filter',
+    name: ENTITY_TYPE_SAVED_FILTER,
+    category: ABSTRACT_INTERNAL_OBJECT,
+    aliased: false,
+  },
+  identifier: {
+    definition: {
+      [ENTITY_TYPE_SAVED_FILTER]: () => uuidv4()
+    },
+  },
+  attributes: [
+    creators,
+    createdAt,
+    {
+      name: 'name',
+      label: 'Name',
+      type: 'string',
+      format: 'short',
+      mandatoryType: 'external',
+      editDefault: false,
+      multiple: false,
+      upsert: false,
+      isFilterable: true
+    },
+    {
+      name: 'filters',
+      label: 'Filters',
+      type: 'string',
+      format: 'text',
+      mandatoryType: 'external',
+      editDefault: false,
+      multiple: false,
+      upsert: false,
+      isFilterable: false
+    },
+    {
+      name: 'scope',
+      label: 'Scope',
+      type: 'string',
+      format: 'short',
+      mandatoryType: 'external',
+      editDefault: false,
+      multiple: false,
+      upsert: false,
+      isFilterable: false
+    }
+  ],
+  relations: [],
+  representative: (instance: StixSavedFilter) => {
+    return instance.name;
+  },
+  converter: convertSavedFiltersToStix,
+};
+
+const isSavedFiltersEnabled = isFeatureEnabled('SAVED_FILTERS');
+
+if (isSavedFiltersEnabled) {
+  registerDefinition(SAVED_FILTER_DEFINITION);
+}

opencti-platform/opencti-graphql/src/modules/savedFilter/savedFilter.ts

@@ -6,6 +6,7 @@ import { ENTITY_TYPE_DELETE_OPERATION } from '../modules/deleteOperation/deleteO
 import { ENTITY_TYPE_DRAFT_WORKSPACE } from '../modules/draftWorkspace/draftWorkspace-types';
 import { ENTITY_TYPE_EXCLUSION_LIST } from '../modules/exclusionList/exclusionList-types';
 import { ENTITY_TYPE_FINTEL_TEMPLATE } from '../modules/fintelTemplate/fintelTemplate-types';
+import { ENTITY_TYPE_SAVED_FILTER } from '../modules/savedFilter/savedFilter-types';
 
 export const ENTITY_TYPE_SETTINGS = 'Settings';
 export const ENTITY_TYPE_MIGRATION_STATUS = 'MigrationStatus';
@@ -45,6 +46,7 @@ const DATED_INTERNAL_OBJECTS = [
   ENTITY_TYPE_DELETE_OPERATION,
   ENTITY_TYPE_DRAFT_WORKSPACE,
   ENTITY_TYPE_EXCLUSION_LIST,
+  ENTITY_TYPE_SAVED_FILTER,
 ];
 const INTERNAL_OBJECTS = [
   ENTITY_TYPE_SETTINGS,
@@ -74,6 +76,7 @@ const INTERNAL_OBJECTS = [
   ENTITY_TYPE_DRAFT_WORKSPACE,
   ENTITY_TYPE_EXCLUSION_LIST,
   ENTITY_TYPE_FINTEL_TEMPLATE,
+  ENTITY_TYPE_SAVED_FILTER,
 ];
 const HISTORY_OBJECTS = [ENTITY_TYPE_WORK];