frontend & backend source code documentation

Author: codeyourweb

.gitignore

@@ -12,10 +12,8 @@
 /data/rulesets/yara_ruleset/*
 /data/rulesets/sigma_ruleset/*
 /data/fluentbit_db/*
-/data/log_ingest_data/evtx/*
-/data/log_ingest_data/auditd/*
-/data/log_ingest_data/json/*
-/data/log_ingest_data/csv/*
+/data/log_ingest_data/*/*
+!/data/log_ingest_data/*/.gitkeep
 /data/mysql_data/*
 /data/yara_triage_data/*
 /docs/graphs/*.bkp

data/log_ingest_data/auditd/.gitkeep

@@ -13,22 +13,47 @@
 use App\Entity\Datasource;
 
 
+/**
+ * Datasource Create Command creates new log data sources for ingestion.
+ * 
+ * This console command allows administrators to create new data source configurations
+ * for log ingestion. Each data source gets a unique ingest key and can be configured
+ * with validity periods and target Elasticsearch indices.
+ */
 #[AsCommand(
     name: 'app:datasource:create',
     description: 'Create a new ingest datasource in the backend application',
 )]
 class DatasourceCreateCommand extends Command
 {
+    /**
+     * Entity manager for database operations.
+     */
     private $entityManager;
+    
+    /**
+     * URL generator for creating ingest URLs.
+     */
     private $urlGenerator;
 
+    /**
+     * Command constructor with dependency injection.
+     * 
+     * @param EntityManagerInterface $entityManager Doctrine entity manager
+     * @param UrlGeneratorInterface $urlGenerator URL generator for ingest endpoints
+     */
     public function __construct(EntityManagerInterface $entityManager, UrlGeneratorInterface $urlGenerator)
     {
         parent::__construct();
         $this->entityManager = $entityManager;
         $this->urlGenerator = $urlGenerator;
     }
 
+    /**
+     * Configure command arguments.
+     * 
+     * Defines required and optional arguments for datasource creation.
+     */
     protected function configure(): void
     {
         $this
@@ -38,8 +63,34 @@ protected function configure(): void
             ->addArgument('validTo', InputArgument::OPTIONAL, '(optional) Valid to (YYYY-MM-DD)');
     }
 
+    /**
+     * Execute the datasource creation command.
+     * 
+     * Creates a new data source with the specified configuration, generates
+     * a unique ingest key, and provides the ingestion endpoint information.
+     * 
+     * @param InputInterface $input Command line input arguments
+     * @param OutputInterface $output Command line output interface
+     * 
+     * @return int Command exit code (SUCCESS or FAILURE)
+     * 
+     * Arguments:
+     * - name: Unique name for the data source
+     * - index: Target Elasticsearch index suffix
+     * - validFrom: Optional start date (YYYY-MM-DD format)
+     * - validTo: Optional end date (YYYY-MM-DD format)
+     * 
+     * Output:
+     * - Success: Datasource details including ingest key and forwarder URL
+     * - Failure: Error message for duplicate names or invalid dates
+     * 
+     * Exit codes:
+     * - Command::SUCCESS (0): Datasource created successfully
+     * - Command::FAILURE (1): Name already exists, invalid dates, or database error
+     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        // Initialize console style helper and extract arguments
         $io = new SymfonyStyle($input, $output);
         $name = $input->getArgument('name');
         $index = $input->getArgument('index');
@@ -49,6 +100,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $validFromDate = null;
         $validToDate = null;
 
+        // Parse and validate optional date arguments
         if ($validFrom) {
             try{
                 $validFromDate = new \DateTime($validFrom);
@@ -67,20 +119,23 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
         }
 
+        // Check for existing datasource with the same name
         $existingDatasource = $this->entityManager->getRepository(Datasource::class)->findOneBy(['name' => $name]);
 
         if ($existingDatasource) {
             $io->error(sprintf('Datasource "%s" already exists.', $name));
             return Command::FAILURE;
         }
 
+        // Create new datasource entity with provided configuration
         $datasource = new Datasource();
         $output->writeln(sprintf('%s - %s', $name, $index));
         $datasource->setName($name);
         $datasource->setTargetIndex($index);
         $datasource->setValidFrom($validFromDate);
         $datasource->setValidTo($validToDate);
 
+        // Persist the new datasource to database
         try {
             $this->entityManager->persist($datasource);
             $this->entityManager->flush();
@@ -89,6 +144,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return Command::FAILURE;
         }
 
+        // Display success information with datasource details
         $io->success(sprintf('Datasource "%s" created successfully', $name));
         $io->writeln(sprintf('Valid from %s', $validFrom ? $validFromDate->format('Y-m-d') : 'N/A'));
         $io->writeln(sprintf('Valid to %s', $validTo ? $validToDate->format('Y-m-d') : 'N/A'));

data/log_ingest_data/csv/.gitkeep

@@ -11,33 +11,71 @@
 use Doctrine\ORM\EntityManagerInterface;
 use App\Entity\Datasource;
 
+/**
+ * Datasource Delete Command removes data sources from the system.
+ * 
+ * This console command allows administrators to permanently delete data source
+ * configurations. Can delete by either ID or name for flexible administration.
+ */
 #[AsCommand(
     name: 'app:datasource:delete',
     description: 'Delete a datasource from the backend application',
 )]
 class DatasourceDeleteCommand extends Command
 {
-
+    /**
+     * Entity manager for database operations.
+     */
     private EntityManagerInterface $entityManager;
 
+    /**
+     * Command constructor with dependency injection.
+     * 
+     * @param EntityManagerInterface $entityManager Doctrine entity manager
+     */
     public function __construct(EntityManagerInterface $entityManager)
     {
         parent::__construct();
         $this->entityManager = $entityManager;
     }
 
+    /**
+     * Configure command arguments.
+     * 
+     * Defines the required ID or name argument for datasource deletion.
+     */
     protected function configure(): void
     {
         $this
             ->addArgument('id', InputArgument::REQUIRED, 'ID or name of the datasource to delete');
     }
 
+    /**
+     * Execute the datasource deletion command.
+     * 
+     * Permanently removes a datasource configuration from the system.
+     * Supports lookup by both numeric ID and string name.
+     * 
+     * @param InputInterface $input Command line input arguments
+     * @param OutputInterface $output Command line output interface
+     * 
+     * @return int Command exit code (SUCCESS or FAILURE)
+     * 
+     * Arguments:
+     * - id: Datasource ID (numeric) or name (string) to delete
+     * 
+     * Exit codes:
+     * - Command::SUCCESS (0): Datasource deleted successfully
+     * - Command::FAILURE (1): Datasource not found or database error
+     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        // Initialize console style helper
         $io = new SymfonyStyle($input, $output);
 
         $dsId = $input->getArgument('id');
 
+        // Determine if searching by ID (numeric) or name (string)
         if (is_numeric(intval($dsId)) && intval($dsId) > 0) {
             $datasource = $this->entityManager->getRepository(Datasource::class)->find((int)$dsId);
         } else {
@@ -49,6 +87,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return Command::FAILURE;
         }
 
+        // Permanently delete the datasource from database
         try{
             $this->entityManager->remove($datasource);
             $this->entityManager->flush();

data/log_ingest_data/evtx/.gitkeep

@@ -10,30 +10,63 @@
 use Doctrine\ORM\EntityManagerInterface;
 use App\Entity\Datasource;
 
+/**
+ * Datasource List Command displays all configured data sources.
+ * 
+ * This console command allows administrators to view all registered data sources
+ * with their configuration details including validity periods and target indices.
+ */
 #[AsCommand(
     name: 'app:datasource:list',
     description: 'List all data sources in the backend application',
 )]
 class DatasourceListCommand extends Command
 {
-
+    /**
+     * Entity manager for database operations.
+     */
     private EntityManagerInterface $entityManager;
 
+    /**
+     * Command constructor with dependency injection.
+     * 
+     * @param EntityManagerInterface $entityManager Doctrine entity manager
+     */
     public function __construct(EntityManagerInterface $entityManager)
     {
         parent::__construct();
         $this->entityManager = $entityManager;
     }
 
+    /**
+     * Configure command (no arguments needed for listing all datasources).
+     */
     protected function configure(): void
     {
     }
 
+    /**
+     * Execute the datasource listing command.
+     * 
+     * Retrieves and displays all data source configurations with their
+     * details including ID, name, target index, and validity periods.
+     * 
+     * @param InputInterface $input Command line input (no arguments)
+     * @param OutputInterface $output Command line output interface
+     * 
+     * @return int Command exit code (always SUCCESS)
+     * 
+     * Output format: "ID: {id} | Name: {name} | Index: {index} | Valid From: {date} | Valid To: {date}"
+     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        // Initialize console style helper
         $io = new SymfonyStyle($input, $output);
 
+        // Retrieve all datasources from database
         $datasources = $this->entityManager->getRepository(Datasource::class)->findAll();
+        
+        // Display each datasource's configuration details
         foreach ($datasources as $datasource) {
             $io->writeln(
                 'ID: ' . $datasource->getId() .