[backend/frontend] Add quick filters on scenarios, simulations and at…

…omic testing (#1294)
OpenBAS-Platform · Sep 5, 2024 · 5d40676 · 5d40676
1 parent 2e610f0
commit 5d40676
Show file tree

Hide file tree

Showing 68 changed files with 1,813 additions and 1,065 deletions.
diff --git a/openbas-api/src/main/java/io/openbas/importer/V1_DataImporter.java b/openbas-api/src/main/java/io/openbas/importer/V1_DataImporter.java
@@ -284,7 +284,10 @@ private Scenario importScenario(JsonNode importNode, Map<String, Base> baseIds)
     scenario.setSubtitle(scenarioNode.get("scenario_subtitle").textValue());
     scenario.setCategory(scenarioNode.get("scenario_category").textValue());
     scenario.setMainFocus(scenarioNode.get("scenario_main_focus").textValue());
-    scenario.setSeverity(scenarioNode.get("scenario_severity").textValue());
+    if (scenarioNode.get("scenario_severity") != null) {
+      String severity = scenarioNode.get("scenario_severity").textValue();
+      scenario.setSeverity(Scenario.SEVERITY.valueOf(severity));
+    }
     if (scenarioNode.get("scenario_recurrence") != null) {
       scenario.setRecurrence(scenarioNode.get("scenario_recurrence").textValue());
     }

diff --git a/openbas-api/src/main/java/io/openbas/rest/exercise/ExerciseApi.java b/openbas-api/src/main/java/io/openbas/rest/exercise/ExerciseApi.java
@@ -39,7 +39,6 @@
 import java.io.InputStream;
 import java.time.Instant;
 import java.util.*;
-import java.util.function.UnaryOperator;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.stream.Collectors;
@@ -53,7 +52,6 @@
 import static io.openbas.database.specification.ExerciseSpecification.findGrantedFor;
 import static io.openbas.helper.StreamHelper.fromIterable;
 import static io.openbas.helper.StreamHelper.iterableToSet;
-import static io.openbas.rest.exercise.utils.ExerciseUtils.handleCustomFilter;
 import static io.openbas.service.ImportService.EXPORT_ENTRY_ATTACHMENT;
 import static io.openbas.service.ImportService.EXPORT_ENTRY_EXERCISE;
 import static io.openbas.utils.pagination.PaginationUtils.buildPaginationCriteriaBuilder;
@@ -644,23 +642,16 @@ public List<ExerciseSimple> exercises() {
 
     @PostMapping(EXERCISE_URI + "/search")
     public Page<ExerciseSimple> exercises(@RequestBody @Valid final SearchPaginationInput searchPaginationInput) {
-        UnaryOperator<Specification<Exercise>> finalSpecification = handleCustomFilter(
-            searchPaginationInput
-        );
-
         if (currentUser().isAdmin()) {
             return buildPaginationCriteriaBuilder(
-                (Specification<Exercise> specification, Pageable pageable) -> this.exerciseService.exercises(
-                    finalSpecification.apply(specification),
-                    pageable
-                ),
+                this.exerciseService::exercises,
                     searchPaginationInput,
                     Exercise.class
             );
         } else {
             return buildPaginationCriteriaBuilder(
                     (Specification<Exercise> specification, Pageable pageable) -> this.exerciseService.exercises(
-                        finalSpecification.apply(findGrantedFor(currentUser().getId()).and(specification)),
+                        findGrantedFor(currentUser().getId()).and(specification),
                             pageable
                     ),
                     searchPaginationInput,

diff --git a/openbas-api/src/main/java/io/openbas/rest/exercise/utils/ExerciseUtils.java b/openbas-api/src/main/java/io/openbas/rest/exercise/utils/ExerciseUtils.java
diff --git a/openbas-api/src/main/java/io/openbas/rest/inject/ExerciseInjectApi.java b/openbas-api/src/main/java/io/openbas/rest/inject/ExerciseInjectApi.java
@@ -1,7 +1,7 @@
 package io.openbas.rest.inject;
 
+import io.openbas.database.model.Inject;
 import io.openbas.database.model.InjectTestStatus;
-import io.openbas.database.specification.InjectSpecification;
 import io.openbas.rest.helper.RestBehavior;
 import io.openbas.rest.inject.output.InjectOutput;
 import io.openbas.service.InjectService;
@@ -16,13 +16,17 @@
 import jakarta.validation.constraints.NotBlank;
 import lombok.RequiredArgsConstructor;
 import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.jpa.domain.Specification;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.transaction.annotation.Transactional;
 import org.springframework.web.bind.annotation.*;
 
 import java.util.List;
 
+import static io.openbas.database.specification.InjectSpecification.fromExercise;
 import static io.openbas.rest.exercise.ExerciseApi.EXERCISE_URI;
+import static io.openbas.utils.pagination.PaginationUtils.buildPaginationCriteriaBuilder;
 
 @RestController
 @RequiredArgsConstructor
@@ -45,7 +49,22 @@ public class ExerciseInjectApi extends RestBehavior {
   @PreAuthorize("isExerciseObserver(#exerciseId)")
   @Transactional(readOnly = true)
   public Iterable<InjectOutput> exerciseInjectsSimple(@PathVariable @NotBlank final String exerciseId) {
-    return injectService.injects(InjectSpecification.fromExercise(exerciseId));
+    return injectService.injects(fromExercise(exerciseId));
+  }
+
+  @PostMapping(EXERCISE_URI + "/{exerciseId}/injects/simple")
+  @PreAuthorize("isExerciseObserver(#exerciseId)")
+  @Transactional(readOnly = true)
+  public Iterable<InjectOutput> exerciseInjectsSimple(
+      @PathVariable @NotBlank final String exerciseId,
+      @RequestBody @Valid final SearchPaginationInput searchPaginationInput) {
+    return buildPaginationCriteriaBuilder(
+        (Specification<Inject> specification, Pageable pageable) -> this.injectService.injects(
+            fromExercise(exerciseId).and(specification), pageable
+        ),
+        searchPaginationInput,
+        Inject.class
+    );
   }
 
   @DeleteMapping(EXERCISE_URI + "/{exerciseId}/injects")

diff --git a/openbas-api/src/main/java/io/openbas/rest/inject/ScenarioInjectApi.java b/openbas-api/src/main/java/io/openbas/rest/inject/ScenarioInjectApi.java
@@ -1,7 +1,7 @@
 package io.openbas.rest.inject;
 
+import io.openbas.database.model.Inject;
 import io.openbas.database.model.InjectTestStatus;
-import io.openbas.database.specification.InjectSpecification;
 import io.openbas.rest.helper.RestBehavior;
 import io.openbas.rest.inject.output.InjectOutput;
 import io.openbas.service.InjectService;
@@ -11,13 +11,17 @@
 import jakarta.validation.constraints.NotBlank;
 import lombok.RequiredArgsConstructor;
 import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.jpa.domain.Specification;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.transaction.annotation.Transactional;
 import org.springframework.web.bind.annotation.*;
 
 import java.util.List;
 
+import static io.openbas.database.specification.InjectSpecification.fromScenario;
 import static io.openbas.rest.scenario.ScenarioApi.SCENARIO_URI;
+import static io.openbas.utils.pagination.PaginationUtils.buildPaginationCriteriaBuilder;
 
 @RestController
 @RequiredArgsConstructor
@@ -31,7 +35,22 @@ public class ScenarioInjectApi extends RestBehavior {
   @PreAuthorize("isScenarioObserver(#scenarioId)")
   @Transactional(readOnly = true)
   public Iterable<InjectOutput> scenarioInjectsSimple(@PathVariable @NotBlank final String scenarioId) {
-    return injectService.injects(InjectSpecification.fromScenario(scenarioId));
+    return injectService.injects(fromScenario(scenarioId));
+  }
+
+  @PostMapping(SCENARIO_URI + "/{scenarioId}/injects/simple")
+  @PreAuthorize("isScenarioObserver(#scenarioId)")
+  @Transactional(readOnly = true)
+  public Iterable<InjectOutput> scenarioInjectsSimple(
+      @PathVariable @NotBlank final String scenarioId,
+      @RequestBody @Valid final SearchPaginationInput searchPaginationInput) {
+    return buildPaginationCriteriaBuilder(
+        (Specification<Inject> specification, Pageable pageable) -> this.injectService.injects(
+            fromScenario(scenarioId).and(specification), pageable
+        ),
+        searchPaginationInput,
+        Inject.class
+    );
   }
 
   @DeleteMapping(SCENARIO_URI + "/{scenarioId}/injects")

diff --git a/openbas-api/src/main/java/io/openbas/rest/injector_contract/InjectorContractApi.java b/openbas-api/src/main/java/io/openbas/rest/injector_contract/InjectorContractApi.java
@@ -16,18 +16,14 @@
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
 import org.springframework.data.domain.Page;
-import org.springframework.data.domain.Pageable;
-import org.springframework.data.jpa.domain.Specification;
 import org.springframework.security.access.annotation.Secured;
 import org.springframework.web.bind.annotation.*;
 
 import java.time.Instant;
-import java.util.function.UnaryOperator;
 
 import static io.openbas.database.model.User.ROLE_ADMIN;
 import static io.openbas.helper.DatabaseHelper.updateRelation;
 import static io.openbas.helper.StreamHelper.fromIterable;
-import static io.openbas.rest.injector_contract.utils.InjectorContractUtils.handleCustomFilter;
 import static io.openbas.utils.pagination.PaginationUtils.buildPaginationCriteriaBuilder;
 
 @RequiredArgsConstructor
@@ -49,15 +45,8 @@ public Iterable<RawInjectorsContrats> injectContracts() {
 
     @PostMapping("/api/injector_contracts/search")
     public Page<InjectorContractOutput> injectorContracts(@RequestBody @Valid final SearchPaginationInput searchPaginationInput) {
-        UnaryOperator<Specification<InjectorContract>> finalSpecification = handleCustomFilter(
-            searchPaginationInput
-        );
-
         return buildPaginationCriteriaBuilder(
-            (Specification<InjectorContract> specification, Pageable pageable) -> this.injectorContractService.injectorContracts(
-                finalSpecification.apply(specification),
-                pageable
-            ),
+            this.injectorContractService::injectorContracts,
                 searchPaginationInput,
                 InjectorContract.class
         );

diff --git a/openbas-api/src/main/java/io/openbas/rest/injector_contract/utils/InjectorContractUtils.java b/openbas-api/src/main/java/io/openbas/rest/injector_contract/utils/InjectorContractUtils.java
diff --git a/openbas-api/src/main/java/io/openbas/rest/payload/PayloadApi.java b/openbas-api/src/main/java/io/openbas/rest/payload/PayloadApi.java
@@ -72,11 +72,6 @@ public void setDocumentRepository(DocumentRepository documentRepository) {
         this.documentRepository = documentRepository;
     }
 
-    @GetMapping("/api/payloads")
-    public Iterable<Payload> payloads() {
-        return payloadRepository.findAll();
-    }
-
     @PostMapping("/api/payloads/search")
     public Page<Payload> payloads(@RequestBody @Valid final SearchPaginationInput searchPaginationInput) {
         return buildPaginationJPA(

diff --git a/openbas-api/src/main/java/io/openbas/rest/scenario/utils/ScenarioUtils.java b/openbas-api/src/main/java/io/openbas/rest/scenario/utils/ScenarioUtils.java
@@ -1,36 +1,57 @@
 package io.openbas.rest.scenario.utils;
 
+import io.openbas.database.model.Filters;
 import io.openbas.database.model.Scenario;
-import io.openbas.utils.CustomFilterUtils;
+import io.openbas.database.specification.ScenarioSpecification;
 import io.openbas.utils.pagination.SearchPaginationInput;
 import org.jetbrains.annotations.NotNull;
 import org.springframework.data.jpa.domain.Specification;
 
-import java.util.Collections;
-import java.util.Map;
+import java.util.Optional;
+import java.util.function.Function;
 import java.util.function.UnaryOperator;
 
-public class ScenarioUtils {
+import static io.openbas.utils.CustomFilterUtils.computeMode;
+import static java.util.Optional.ofNullable;
 
-  private static final String SCENARIO_KILL_CHAIN_PHASES_FILTER = "scenario_kill_chain_phases";
-  private static final Map<String, String> CORRESPONDENCE_MAP = Collections.singletonMap(
-      SCENARIO_KILL_CHAIN_PHASES_FILTER, "injects.injectorContract.attackPatterns.killChainPhases.id"
-  );
+public class ScenarioUtils {
 
   private ScenarioUtils() {
 
   }
 
+  private static final String SCENARIO_RECURRENCE_FILTER = "scenario_recurrence";
+
   /**
    * Manage filters that are not directly managed by the generic mechanics -> scenario_kill_chain_phases
    */
-  public static UnaryOperator<Specification<Scenario>> handleCustomFilter(
+  public static Function<Specification<Scenario>, Specification<Scenario>> handleDeepFilter(
+      @NotNull final SearchPaginationInput searchPaginationInput) {
+    return handleCustomFilter(searchPaginationInput);
+  }
+
+  private static UnaryOperator<Specification<Scenario>> handleCustomFilter(
       @NotNull final SearchPaginationInput searchPaginationInput) {
-    return CustomFilterUtils.handleCustomFilter(
-        searchPaginationInput,
-        SCENARIO_KILL_CHAIN_PHASES_FILTER,
-        CORRESPONDENCE_MAP
-    );
+    // Existence of the filter
+    Optional<Filters.Filter> scenarioRecurrenceFilterOpt = ofNullable(searchPaginationInput.getFilterGroup())
+        .flatMap(f -> f.findByKey(SCENARIO_RECURRENCE_FILTER));
+
+    if (scenarioRecurrenceFilterOpt.isPresent()) {
+      // Purge filter
+      searchPaginationInput.getFilterGroup().removeByKey(SCENARIO_RECURRENCE_FILTER);
+      Specification<Scenario> customSpecification = null;
+      if (scenarioRecurrenceFilterOpt.get().getValues().contains("Scheduled")) {
+        customSpecification = ScenarioSpecification.isRecurring();
+      } else if (scenarioRecurrenceFilterOpt.get().getValues().contains("Not planned")) {
+        customSpecification = ScenarioSpecification.noRecurring();
+      }
+      if (customSpecification != null) {
+        return computeMode(searchPaginationInput, customSpecification);
+      }
+      return (Specification<Scenario> specification) -> specification;
+    } else {
+      return (Specification<Scenario> specification) -> specification;
+    }
   }
 
 }
diff --git a/openbas-api/src/main/java/io/openbas/service/AtomicTestingService.java b/openbas-api/src/main/java/io/openbas/service/AtomicTestingService.java
@@ -266,7 +266,7 @@ public void deleteAtomicTesting(String injectId) {
 
     // -- PAGINATION --
 
-    public Page<AtomicTestingOutput> findAllAtomicTestings(SearchPaginationInput searchPaginationInput) {
+    public Page<AtomicTestingOutput> findAllAtomicTestings(@NotNull final SearchPaginationInput searchPaginationInput) {
         Specification<Inject> customSpec = Specification.where((root, query, cb) -> {
             Predicate predicate = cb.conjunction();
             predicate = cb.and(predicate, cb.isNull(root.get("scenario")));
@@ -275,7 +275,7 @@ public Page<AtomicTestingOutput> findAllAtomicTestings(SearchPaginationInput sea
         });
         return buildPaginationCriteriaBuilder(
                 (Specification<Inject> specification, Pageable pageable) -> this.atomicTestings(
-                        specification.and(customSpec), pageable),
+                    customSpec.and(specification), pageable),
                 searchPaginationInput,
                 Inject.class
         );