Feature/248 refactor project structure

.github/workflows/ci.yml

@@ -60,7 +60,7 @@ jobs:
         run:  go install github.com/swaggo/swag/cmd/swag@latest  
         timeout-minutes: 12
       - name: Start docker containers for test
-        run: docker compose -f "docker/testing/httpbin-test/docker-compose.yml" up -d --build
+        run: docker compose -f "deployments/docker/testing/httpbin-test/docker-compose.yml" up -d --build
       - name: Run tests
         run: |
           sudo apt update

.github/workflows/release.yml

@@ -109,7 +109,6 @@ jobs:
         run: |
           go install github.com/swaggo/swag/cmd/swag@latest
           go install github.com/CycloneDX/cyclonedx-gomod/cmd/cyclonedx-gomod@latest
-          swag init -o swaggerdocs
           make sbom
           zip -r bin/sbom.zip bin
 

.gitignore

@@ -9,7 +9,7 @@ plugins/*
 build/*
 !build/build.md
 bin/*
-swaggerdocs/*
+api/*
 **.env
 test/cacao/flatfile-db-example.json
 

README.md

@@ -1,5 +1,5 @@
 <div align="center">
-<a href="https://cossas-project.org/cossas-software/soarca"><img src="img/soarca-logo.svg"/>
+<a href="https://cossas-project.org/cossas-software/soarca"><img src="assets/soarca-logo.svg"/>
 
 
 [![https://cossas-project.org/portfolio/SOARCA/](https://img.shields.io/badge/website-cossas--project.org-orange)](https://cossas-project.org/portfolio/SOARCA/)

main.go → cmd/soarca/main.go

@@ -3,11 +3,11 @@ package main
 import (
 	"fmt"
 
+	api "soarca/api"
 	"soarca/internal/controller"
-	"soarca/logger"
-	"soarca/routes/status"
-	"soarca/swaggerdocs"
-	"soarca/utils"
+	"soarca/internal/logger"
+	"soarca/pkg/api/status"
+	"soarca/pkg/utils"
 
 	"github.com/joho/godotenv"
 )
@@ -36,25 +36,25 @@ const banner = `
 
 `
 
-//	@title		SOARCA API
-//	@version	1.0.0
+// @title		SOARCA API
+// @version	1.0.0
 func main() {
 	fmt.Print(banner)
 	log.Info("Version: ", Version)
 	log.Info("Buildtime: ", Buildtime)
 
-	errenv := godotenv.Load(".env")
-	if errenv != nil {
+	err := godotenv.Load(".env")
+	if err != nil {
 		log.Warning("Failed to read env variable, but will continue")
 	}
 	Host = "localhost:" + utils.GetEnv("PORT", "8080")
-	swaggerdocs.SwaggerInfo.Host = Host
+	api.SwaggerInfo.Host = Host
 
 	// Version is only available here
 	status.SetVersion(Version)
-	errinit := controller.Initialize()
-	if errinit != nil {
-		log.Fatal("Something Went wrong with setting-up the app, msg: ", errinit)
-		panic(errinit)
+	err = controller.Initialize()
+	if err != nil {
+		log.Fatal("Something Went wrong with setting-up the app, msg: ", err)
+		panic(err)
 	}
 }

docs/content/en/docs/core-components/soarca-application-design.md

@@ -26,42 +26,61 @@ set separator ::
 
 protocol /playbook #lightgreen
 protocol /trigger #lightgreen
+protocol /status #lightgreen
+protocol /reporter #lightgreen
 protocol /step #red
 protocol /trusted/variables #red
-protocol /status #red
 
-class controller  #lightgreen
-class database  #lightgreen
-class log  #lightgreen
+class internal::controller  #lightgreen
+class internal::database  #lightgreen
+class internal::logger  #lightgreen
 class core::decomposer #lightgreen
 class core::executor  #lightgreen
-class endpoints::playbook #lightgreen
-class endpoints::trigger #lightgreen
-class core::modules::http #lightgreen
-class core::modules::ssh #lightgreen
-class core::modules::openC2 #orange
-class core::modules::fin #orange
+class api::playbook #lightgreen
+class api::trigger #lightgreen
+class core::capability::http #lightgreen
+class core::capability::ssh #lightgreen
+class core::capability::openC2 #lightgreen
+class core::capability::fin #lightgreen
+class core::capability::powershell #lightgreen
+class api::status #lightgreen
+class api::reporter #lightgreen
 
-class endpoints::step #red
-class endpoints::variables #red
-class endpoints::status #red
+class api::step #red
+class api::variables #red
 
+class api::reporter #lightgreen
 
-"/step" *-- endpoints::step 
-"/playbook" *-- endpoints::playbook
-"/trigger" *-- endpoints::trigger
-"/status" *-- endpoints::status
-"/trusted/variables" *-- endpoints::variables
+class reporter::cache #orange
 
-endpoints *-down- controller
+
+"/step" *-- api::step 
+"/playbook" *-- api::playbook
+"/trigger" *-- api::trigger
+"/status" *-- api::status
+"/reporter" *-- api::reporter
+"/trusted/variables" *-- api::variables
+
+api *-down- controller
 controller -* database
-log *- controller
-controller -down-* core::decomposer
+logger *- controller
+controller -down-* core
+
+api::reporter -down-> reporter::cache
+
+reporter::cache <-- core::decomposer
+reporter::cache <-- core::executor
+
+api::playbook --> internal::database
+api::trigger --> core::decomposer
+api::trigger --> internal::database
+
 core::decomposer -down-> core::executor
-core::executor --> core::modules::openC2
-core::executor --> core::modules::fin
-core::executor --> core::modules::http
-core::executor --> core::modules::ssh
+core::executor --> core::capability::openC2
+core::executor --> core::capability::fin
+core::executor --> core::capability::http
+core::executor --> core::capability::ssh
+core::executor --> core::capability::powershell
 @enduml
 ```
 
@@ -108,7 +127,7 @@ ICapability <- Executer
 ```
 
 ### Controller
-The SOARCA controller will create all classed needed by SOARCA. The controller glues the endpoints and decomposer together. Each run will instantiate a new decomposer. 
+The SOARCA controller will create all classes needed by SOARCA. The controller glues the api and decomposer together. Each run will instantiate a new decomposer. 
 
 ```plantuml
 interface IPlaybook{

internal/controller/controller.go

@@ -8,36 +8,36 @@ import (
 	"strconv"
 	"strings"
 
-	"soarca/internal/capability"
-	capabilityController "soarca/internal/capability/controller"
-	finExecutor "soarca/internal/capability/fin"
-	"soarca/internal/capability/http"
-	"soarca/internal/capability/openc2"
-	"soarca/internal/capability/powershell"
-	"soarca/internal/capability/ssh"
-	"soarca/internal/decomposer"
-	"soarca/internal/executors/action"
-	"soarca/internal/executors/condition"
-	"soarca/internal/executors/playbook_action"
-	"soarca/internal/fin/protocol"
-	"soarca/internal/guid"
-	"soarca/internal/reporter"
-	cache "soarca/internal/reporter/downstream_reporter/cache"
-	"soarca/internal/reporter/downstream_reporter/thehive"
-	"soarca/logger"
-	"soarca/utils"
-	httpUtil "soarca/utils/http"
-	"soarca/utils/stix/expression/comparison"
-	timeUtil "soarca/utils/time"
-
-	downstreamReporter "soarca/internal/reporter/downstream_reporter"
+	"soarca/internal/logger"
+	"soarca/pkg/core/capability"
+	capabilityController "soarca/pkg/core/capability/controller"
+	finExecutor "soarca/pkg/core/capability/fin"
+	"soarca/pkg/core/capability/fin/protocol"
+	"soarca/pkg/core/capability/http"
+	"soarca/pkg/core/capability/openc2"
+	"soarca/pkg/core/capability/powershell"
+	"soarca/pkg/core/capability/ssh"
+	"soarca/pkg/core/decomposer"
+	"soarca/pkg/core/executors/action"
+	"soarca/pkg/core/executors/condition"
+	"soarca/pkg/core/executors/playbook_action"
+	thehive "soarca/pkg/integration/thehive/reporter"
+	"soarca/pkg/reporter"
+	cache "soarca/pkg/reporter/downstream_reporter/cache"
+	"soarca/pkg/utils"
+	"soarca/pkg/utils/guid"
+	httpUtil "soarca/pkg/utils/http"
+	"soarca/pkg/utils/stix/expression/comparison"
+	timeUtil "soarca/pkg/utils/time"
+
+	downstreamReporter "soarca/pkg/reporter/downstream_reporter"
 
 	"github.com/gin-gonic/gin"
 
-	"soarca/database/memory"
-	mongo "soarca/database/mongodb"
-	playbookrepository "soarca/database/playbook"
-	"soarca/routes"
+	"soarca/internal/database/memory"
+	mongo "soarca/internal/database/mongodb"
+	playbookrepository "soarca/internal/database/playbook"
+	routes "soarca/pkg/api"
 )
 
 var log *logger.Log

internal/controller/database/controller_database.go

@@ -1,7 +1,7 @@
 package database
 
 import (
-	playbookrepository "soarca/database/playbook"
+	playbookrepository "soarca/internal/database/playbook"
 )
 
 type IController interface {

internal/controller/decomposer_controller/controller_decomposer.go

@@ -1,7 +1,7 @@
 package decomposer_controller
 
 import (
-	"soarca/internal/decomposer"
+	"soarca/pkg/core/decomposer"
 )
 
 type IController interface {

internal/controller/informer/execution_informer.go

@@ -1,7 +1,7 @@
 package informer
 
 import (
-	"soarca/models/cache"
+	"soarca/pkg/models/cache"
 
 	"github.com/google/uuid"
 )

database/memory/memory.go → internal/database/memory/memory.go

@@ -2,9 +2,9 @@ package memory
 
 import (
 	"errors"
-	"soarca/models/api"
-	"soarca/models/cacao"
-	"soarca/models/decoder"
+	"soarca/pkg/models/api"
+	"soarca/pkg/models/cacao"
+	"soarca/pkg/models/decoder"
 )
 
 type InMemoryDatabase struct {

database/memory/memory_test.go → internal/database/memory/memory_test.go

@@ -6,15 +6,15 @@ import (
 	"fmt"
 	"io"
 	"os"
-	"soarca/models/cacao"
-	"soarca/models/decoder"
+	"soarca/pkg/models/cacao"
+	"soarca/pkg/models/decoder"
 	"sort"
 	"testing"
 
 	"github.com/go-playground/assert/v2"
 )
 
-var PB_PATH string = "../../test/playbooks/"
+var PB_PATH string = "../../../test/playbooks/"
 
 func TestCreate(t *testing.T) {
 	jsonFile, err := os.Open(PB_PATH + "playbook.json")

database/mongodb/init.go → internal/database/mongodb/init.go

@@ -3,7 +3,7 @@ package mongodb
 import (
 	"reflect"
 
-	"soarca/logger"
+	"soarca/internal/logger"
 )
 
 var log *logger.Log

database/mongodb/mongo.go → internal/database/mongodb/mongo.go

@@ -6,8 +6,8 @@ import (
 	"reflect"
 	"time"
 
-	"soarca/database/projections"
-	cacao "soarca/models/cacao"
+	"soarca/internal/database/projections"
+	cacao "soarca/pkg/models/cacao"
 
 	"go.mongodb.org/mongo-driver/bson"
 	mongo "go.mongodb.org/mongo-driver/mongo"

database/playbook/playbook.go → internal/database/playbook/playbook.go

@@ -3,12 +3,12 @@ package playbookrepository
 import (
 	"errors"
 
-	database "soarca/database"
-	"soarca/database/projections"
+	database "soarca/internal/database"
+	"soarca/internal/database/projections"
 	validator "soarca/internal/validators"
-	"soarca/models/api"
-	"soarca/models/cacao"
-	"soarca/models/decoder"
+	"soarca/pkg/models/api"
+	"soarca/pkg/models/cacao"
+	"soarca/pkg/models/decoder"
 )
 
 type IPlaybookRepository interface {

logger/logger.go → internal/logger/logger.go

@@ -3,7 +3,7 @@ package logger
 import (
 	"fmt"
 	"os"
-	"soarca/utils"
+	"soarca/pkg/utils"
 	"strings"
 
 	logrus "github.com/sirupsen/logrus"