[Backend] Refactor creation of inject expectations

OpenBAS-Platform · Dec 5, 2024 · df1ff7a · df1ff7a
1 parent 36506e1
commit df1ff7a
Show file tree

Hide file tree

Showing 18 changed files with 267 additions and 275 deletions.
diff --git a/openbas-api/src/main/java/io/openbas/injectors/caldera/CalderaExecutor.java b/openbas-api/src/main/java/io/openbas/injectors/caldera/CalderaExecutor.java
@@ -19,6 +19,7 @@
 import io.openbas.database.repository.InjectRepository;
 import io.openbas.execution.ExecutableInject;
 import io.openbas.execution.Injector;
+import io.openbas.inject_expectation.InjectExpectationService;
 import io.openbas.injectors.caldera.client.model.Ability;
 import io.openbas.injectors.caldera.client.model.Agent;
 import io.openbas.injectors.caldera.client.model.ExploitResult;
@@ -51,6 +52,7 @@ public class CalderaExecutor extends Injector {
   private final CalderaInjectorService calderaService;
   private final EndpointService endpointService;
   private final AssetGroupService assetGroupService;
+  private final InjectExpectationService injectExpectationService;
   private final InjectRepository injectRepository;
 
   @Override
@@ -264,9 +266,11 @@ public ExecutionProcess process(
         (assetGroup ->
             computeExpectationsForAssetGroup(
                 expectations, content, assetGroup, new ArrayList<>())));
+
     String message = "Caldera executed the ability on " + asyncIds.size() + " asset(s)";
     execution.addTrace(traceInfo(message, asyncIds));
-    return new ExecutionProcess(true, expectations);
+    injectExpectationService.buildAndSaveInjectExpectations(injection, expectations);
+    return new ExecutionProcess(true);
   }
 
   @Override

diff --git a/openbas-api/src/main/java/io/openbas/injectors/challenge/ChallengeExecutor.java b/openbas-api/src/main/java/io/openbas/injectors/challenge/ChallengeExecutor.java
@@ -11,6 +11,7 @@
 import io.openbas.execution.ExecutableInject;
 import io.openbas.execution.ExecutionContext;
 import io.openbas.execution.Injector;
+import io.openbas.inject_expectation.InjectExpectationService;
 import io.openbas.injectors.challenge.model.ChallengeContent;
 import io.openbas.injectors.challenge.model.ChallengeVariable;
 import io.openbas.injectors.email.service.EmailService;
@@ -24,32 +25,23 @@
 import java.util.List;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
-import org.springframework.beans.factory.annotation.Autowired;
+import lombok.RequiredArgsConstructor;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 
 @Component(ChallengeContract.TYPE)
+@RequiredArgsConstructor
 public class ChallengeExecutor extends Injector {
 
   @Resource private OpenBASConfig openBASConfig;
 
-  private ChallengeRepository challengeRepository;
-
-  private EmailService emailService;
+  private final ChallengeRepository challengeRepository;
+  private final EmailService emailService;
+  private final InjectExpectationService injectExpectationService;
 
   @Value("${openbas.mail.imap.enabled}")
   private boolean imapEnabled;
 
-  @Autowired
-  public void setChallengeRepository(ChallengeRepository challengeRepository) {
-    this.challengeRepository = challengeRepository;
-  }
-
-  @Autowired
-  public void setEmailService(EmailService emailService) {
-    this.emailService = emailService;
-  }
-
   private String buildChallengeUri(
       ExecutionContext context, Exercise exercise, Challenge challenge) {
     String userId = context.getUser().getId();
@@ -147,13 +139,16 @@ public ExecutionProcess process(
                           })
                   .toList());
         }
-        return new ExecutionProcess(false, expectations);
+
+        injectExpectationService.buildAndSaveInjectExpectations(injection, expectations);
+
+        return new ExecutionProcess(false);
       } else {
         throw new UnsupportedOperationException("Unknown contract " + contract);
       }
     } catch (Exception e) {
       execution.addTrace(traceError(e.getMessage()));
     }
-    return new ExecutionProcess(false, List.of());
+    return new ExecutionProcess(false);
   }
 }
diff --git a/openbas-api/src/main/java/io/openbas/injectors/channel/ChannelExecutor.java b/openbas-api/src/main/java/io/openbas/injectors/channel/ChannelExecutor.java
@@ -11,6 +11,7 @@
 import io.openbas.execution.ExecutableInject;
 import io.openbas.execution.ExecutionContext;
 import io.openbas.execution.Injector;
+import io.openbas.inject_expectation.InjectExpectationService;
 import io.openbas.injectors.channel.model.ArticleVariable;
 import io.openbas.injectors.channel.model.ChannelContent;
 import io.openbas.injectors.email.service.EmailService;
@@ -24,36 +25,25 @@
 import java.util.List;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
-import org.springframework.beans.factory.annotation.Autowired;
+import lombok.RequiredArgsConstructor;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 
 @Component(ChannelContract.TYPE)
+@RequiredArgsConstructor
 public class ChannelExecutor extends Injector {
 
   public static final String VARIABLE_ARTICLES = "articles";
-
   public static final String VARIABLE_ARTICLE = "article";
 
   @Resource private OpenBASConfig openBASConfig;
-
-  private ArticleRepository articleRepository;
-
-  private EmailService emailService;
+  private final ArticleRepository articleRepository;
+  private final EmailService emailService;
+  private final InjectExpectationService injectExpectationService;
 
   @Value("${openbas.mail.imap.enabled}")
   private boolean imapEnabled;
 
-  @Autowired
-  public void setArticleRepository(ArticleRepository articleRepository) {
-    this.articleRepository = articleRepository;
-  }
-
-  @Autowired
-  public void setEmailService(EmailService emailService) {
-    this.emailService = emailService;
-  }
-
   private String buildArticleUri(ExecutionContext context, Article article) {
     String userId = context.getUser().getId();
     String channelId = article.getChannel().getId();
@@ -153,13 +143,16 @@ public ExecutionProcess process(
                           })
                   .toList());
         }
-        return new ExecutionProcess(false, expectations);
+
+        injectExpectationService.buildAndSaveInjectExpectations(injection, expectations);
+
+        return new ExecutionProcess(false);
       } else {
         throw new UnsupportedOperationException("Unknown contract " + contract);
       }
     } catch (Exception e) {
       execution.addTrace(traceError(e.getMessage()));
     }
-    return new ExecutionProcess(false, List.of());
+    return new ExecutionProcess(false);
   }
 }
diff --git a/openbas-api/src/main/java/io/openbas/injectors/email/EmailExecutor.java b/openbas-api/src/main/java/io/openbas/injectors/email/EmailExecutor.java
@@ -8,6 +8,7 @@
 import io.openbas.execution.ExecutableInject;
 import io.openbas.execution.ExecutionContext;
 import io.openbas.execution.Injector;
+import io.openbas.inject_expectation.InjectExpectationService;
 import io.openbas.injectors.email.model.EmailContent;
 import io.openbas.injectors.email.service.EmailService;
 import io.openbas.model.ExecutionProcess;
@@ -17,25 +18,21 @@
 import jakarta.validation.constraints.NotNull;
 import java.util.List;
 import java.util.stream.Stream;
-import org.springframework.beans.factory.annotation.Autowired;
+import lombok.RequiredArgsConstructor;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 
 @Component(EmailContract.TYPE)
+@RequiredArgsConstructor
 public class EmailExecutor extends Injector {
 
   @Resource private OpenBASConfig openBASConfig;
-
-  private EmailService emailService;
+  private final EmailService emailService;
+  private final InjectExpectationService injectExpectationService;
 
   @Value("${openbas.mail.imap.enabled}")
   private boolean imapEnabled;
 
-  @Autowired
-  public void setEmailService(EmailService emailService) {
-    this.emailService = emailService;
-  }
-
   private void sendMulti(
       Execution execution,
       List<ExecutionContext> users,
@@ -135,6 +132,9 @@ public ExecutionProcess process(
                       default -> Stream.of();
                     })
             .toList();
-    return new ExecutionProcess(false, expectations);
+
+    injectExpectationService.buildAndSaveInjectExpectations(injection, expectations);
+
+    return new ExecutionProcess(false);
   }
 }
diff --git a/openbas-api/src/main/java/io/openbas/injectors/lade/LadeExecutor.java b/openbas-api/src/main/java/io/openbas/injectors/lade/LadeExecutor.java
@@ -50,6 +50,6 @@ public ExecutionProcess process(
     } catch (Exception e) {
       execution.addTrace(traceError(e.getMessage()));
     }
-    return new ExecutionProcess(true, List.of());
+    return new ExecutionProcess(true);
   }
 }
diff --git a/openbas-api/src/main/java/io/openbas/injectors/mastodon/MastodonExecutor.java b/openbas-api/src/main/java/io/openbas/injectors/mastodon/MastodonExecutor.java
@@ -41,6 +41,6 @@ public ExecutionProcess process(
     } catch (Exception e) {
       execution.addTrace(traceError(e.getMessage()));
     }
-    return new ExecutionProcess(false, List.of());
+    return new ExecutionProcess(false);
   }
 }
diff --git a/openbas-api/src/main/java/io/openbas/injectors/openbas/OpenBASImplantExecutor.java b/openbas-api/src/main/java/io/openbas/injectors/openbas/OpenBASImplantExecutor.java
@@ -14,6 +14,7 @@
 import io.openbas.database.repository.InjectRepository;
 import io.openbas.execution.ExecutableInject;
 import io.openbas.execution.Injector;
+import io.openbas.inject_expectation.InjectExpectationService;
 import io.openbas.injectors.openbas.model.OpenBASImplantInjectContent;
 import io.openbas.model.ExecutionProcess;
 import io.openbas.model.Expectation;
@@ -34,6 +35,7 @@ public class OpenBASImplantExecutor extends Injector {
 
   private final AssetGroupService assetGroupService;
   private final InjectRepository injectRepository;
+  private final InjectExpectationService injectExpectationService;
 
   private Map<Asset, Boolean> resolveAllAssets(@NotNull final ExecutableInject inject) {
     Map<Asset, Boolean> assets = new HashMap<>();
@@ -266,7 +268,10 @@ public ExecutionProcess process(Execution execution, ExecutableInject injection)
         (assetGroup ->
             computeExpectationsForAssetGroup(
                 expectations, content, assetGroup, new ArrayList<>())));
-    return new ExecutionProcess(true, expectations);
+
+    injectExpectationService.buildAndSaveInjectExpectations(injection, expectations);
+
+    return new ExecutionProcess(true);
   }
 
   private List<InjectExpectationSignature> spawnSignatures(Inject inject, Payload payload) {

diff --git a/openbas-api/src/main/java/io/openbas/injectors/opencti/OpenCTIExecutor.java b/openbas-api/src/main/java/io/openbas/injectors/opencti/OpenCTIExecutor.java
@@ -6,6 +6,7 @@
 import io.openbas.database.model.*;
 import io.openbas.execution.ExecutableInject;
 import io.openbas.execution.Injector;
+import io.openbas.inject_expectation.InjectExpectationService;
 import io.openbas.injectors.opencti.model.CaseContent;
 import io.openbas.injectors.opencti.service.OpenCTIService;
 import io.openbas.model.ExecutionProcess;
@@ -14,18 +15,15 @@
 import jakarta.validation.constraints.NotNull;
 import java.util.List;
 import java.util.stream.Stream;
-import org.springframework.beans.factory.annotation.Autowired;
+import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Component;
 
 @Component(OpenCTIContract.TYPE)
+@RequiredArgsConstructor
 public class OpenCTIExecutor extends Injector {
 
-  private OpenCTIService openCTIService;
-
-  @Autowired
-  public void setOpenCTIService(OpenCTIService openCTIService) {
-    this.openCTIService = openCTIService;
-  }
+  private final OpenCTIService openCTIService;
+  private final InjectExpectationService injectExpectationService;
 
   private void createCase(
       Execution execution, String name, String description, List<DataAttachment> attachments) {
@@ -79,6 +77,9 @@ public ExecutionProcess process(
                       default -> Stream.of();
                     })
             .toList();
-    return new ExecutionProcess(false, expectations);
+
+    injectExpectationService.buildAndSaveInjectExpectations(injection, expectations);
+
+    return new ExecutionProcess(false);
   }
 }
diff --git a/openbas-api/src/main/java/io/openbas/injectors/ovh/OvhSmsExecutor.java b/openbas-api/src/main/java/io/openbas/injectors/ovh/OvhSmsExecutor.java
@@ -10,13 +10,13 @@
 import io.openbas.execution.ExecutionContext;
 import io.openbas.execution.Injector;
 import io.openbas.execution.ProtectUser;
+import io.openbas.inject_expectation.InjectExpectationService;
 import io.openbas.injectors.ovh.model.OvhSmsContent;
 import io.openbas.injectors.ovh.service.OvhSmsService;
 import io.openbas.model.ExecutionProcess;
 import io.openbas.model.Expectation;
 import io.openbas.model.expectation.ManualExpectation;
 import jakarta.validation.constraints.NotNull;
-import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.regex.Matcher;
@@ -31,6 +31,7 @@
 public class OvhSmsExecutor extends Injector {
 
   private final OvhSmsService smsService;
+  private final InjectExpectationService injectExpectationService;
 
   @Override
   public ExecutionProcess process(
@@ -95,8 +96,11 @@ public ExecutionProcess process(
                         default -> Stream.of();
                       })
               .toList();
-      return new ExecutionProcess(false, expectations);
+
+      injectExpectationService.buildAndSaveInjectExpectations(injection, expectations);
+
+      return new ExecutionProcess(false);
     }
-    return new ExecutionProcess(false, Collections.emptyList());
+    return new ExecutionProcess(false);
   }
 }
diff --git a/openbas-api/src/main/java/io/openbas/rest/inject/InjectApi.java b/openbas-api/src/main/java/io/openbas/rest/inject/InjectApi.java
@@ -124,7 +124,7 @@ public Inject injectExecutionCallback(
     if (ExecutionTraceStatus.SUCCESS.equals(executionStatus)) {
       injectStatus.setTrackingTotalSuccess(injectStatus.getTrackingTotalSuccess() + 1);
     } else {
-      injectStatus.setTrackingTotalError(injectStatus.getTrackingTotalSuccess() + 1);
+      injectStatus.setTrackingTotalError(injectStatus.getTrackingTotalError() + 1);
     }
 
     int currentTotal =

diff --git a/openbas-api/src/main/java/io/openbas/utils/AtomicTestingUtils.java b/openbas-api/src/main/java/io/openbas/utils/AtomicTestingUtils.java
@@ -538,7 +538,10 @@ public static InjectExpectation.EXPECTATION_STATUS getResult(final OptionalDoubl
   }
 
   public static OptionalDouble calculateAverageFromExpectations(final List<Double> scores) {
-    return scores.stream().filter(Objects::nonNull).mapToDouble(Double::doubleValue).average();
+    return scores.stream()
+        .filter(Objects::nonNull)
+        .mapToDouble(Double::doubleValue)
+        .average(); // Null values are expectations for injects in Pending
   }
 
   public static List<ResultDistribution> getResultDetail(