bugfix/330 manual commands not working (#331)

Author: MaartendeKruijf

examples/manual-playbook.json

@@ -22,6 +22,7 @@
     ],
     "external_references": [
         {
+            "name": "COSSAS",
             "description": "TNO COSSAS"
         }
     ],
@@ -46,6 +47,7 @@
             },
             "on_completion": "end--a6f0b81e-affb-4bca-b4f6-a2d5af908958",
             "type": "action",
+            "timeout": 100000,
             "commands": [
                 {
                     "type": "manual",
@@ -71,16 +73,16 @@
             "name": "soarca-manual-capability"
         },
         "soarca-manual-capability--7b0e98db-fa93-42aa-8511-e871c65131b1": {
-            "type": "soarca-manual-capability",
-            "name": "soarca-manual-capability",
-            "description": "SOARCA's manual command handler"
+            "type": "soarca-manual",
+            "name": "soarca-manual",
+            "description": "SOARCAs manual command handler"
         }
     },
     "target_definitions": {
         "individual--9d1f6217-34d5-435c-b29a-6a1af6b664d9": {
             "type": "individual",
             "name": "Luke Skywalker",
-            "description": "Darth Vader's son",
+            "description": "Darth Vaders son",
             "location": {
                 "name": "Somewhere in a galaxy far far away"
             }

internal/controller/controller.go

@@ -7,9 +7,11 @@ import (
 	"reflect"
 	"soarca/internal/database/memory"
 	"soarca/internal/logger"
+
 	"soarca/pkg/core/capability"
 	"soarca/pkg/core/capability/fin/protocol"
 	"soarca/pkg/core/capability/http"
+	"soarca/pkg/core/capability/manual"
 	"soarca/pkg/core/capability/manual/interaction"
 	"soarca/pkg/core/capability/openc2"
 	"soarca/pkg/core/capability/powershell"
@@ -85,6 +87,9 @@ func (controller *Controller) NewDecomposer() decomposer.IDecomposer {
 	poswershell := powershell.New()
 	capabilities[poswershell.GetType()] = poswershell
 
+	man := manual.New(mainInteraction)
+	capabilities[man.GetType()] = &man
+
 	enableFins, _ := strconv.ParseBool(utils.GetEnv("ENABLE_FINS", "false"))
 
 	if enableFins {

pkg/api/manual/manual_api.go

@@ -52,14 +52,14 @@ func NewManualHandler(interaction interaction.IInteractionStorage) *ManualHandle
 
 // manual
 //
-//	@Summary		get all pending manual commands that still needs values to be returned
+//	@Summary	get all pending manual commands that still needs values to be returned
 //	@Schemes
 //	@Description	get all pending manual commands that still needs values to be returned
 //	@Tags			manual
 //	@Accept			json
 //	@Produce		json
-//	@Success		200		{object}	api.Execution
-//	@failure		400		{object}	[]api.InteractionCommandData
+//	@Success		200	{object}	api.Execution
+//	@failure		400	{object}	[]api.InteractionCommandData
 //	@Router			/manual/ [GET]
 func (manualHandler *ManualHandler) GetPendingCommands(g *gin.Context) {
 	commands, err := manualHandler.interactionCapability.GetPendingCommands()
@@ -82,14 +82,14 @@ func (manualHandler *ManualHandler) GetPendingCommands(g *gin.Context) {
 
 // manual
 //
-//	@Summary		get a specific manual command that still needs a value to be returned
+//	@Summary	get a specific manual command that still needs a value to be returned
 //	@Schemes
 //	@Description	get a specific manual command that still needs a value to be returned
 //	@Tags			manual
 //	@Accept			json
 //	@Produce		json
-//	@Param			exec_id	path	string	true	"execution ID"
-//	@Param			step_id	path	string	true	"step ID"
+//	@Param			exec_id	path		string	true	"execution ID"
+//	@Param			step_id	path		string	true	"step ID"
 //	@Success		200		{object}	api.InteractionCommandData
 //	@failure		400		{object}	api.Error
 //	@Router			/manual/{exec_id}/{step_id} [GET]
@@ -126,23 +126,17 @@ func (manualHandler *ManualHandler) GetPendingCommand(g *gin.Context) {
 
 // manual
 //
-//	@Summary		updates the value of a variable according to the manual interaction
+//	@Summary	updates the value of a variable according to the manual interaction
 //	@Schemes
 //	@Description	updates the value of a variable according to the manual interaction
 //	@Tags			manual
 //	@Accept			json
 //	@Produce		json
-//	@Param			exec_id				path	string			true	"execution ID"
-//	@Param			step_id				path	string			true	"step ID"
-//	@Param			type				body	string			true	"type"
-//	@Param			outArgs				body	string			true	"execution ID"
-//	@Param			execution_id		body	string			true	"playbook ID"
-//	@Param			playbook_id			body	string			true	"playbook ID"
-//	@Param			step_id				body	string			true	"step ID"
-//	@Param			response_status		body	string			true	"response status"
-//	@Param			response_out_args	body	cacao.Variables	true	"out args"
-//	@Success		200			{object}	api.Execution
-//	@failure		400			{object}	api.Error
+//	@Param			exec_id	path		string							true	"execution ID"
+//	@Param			step_id	path		string							true	"step ID"
+//	@Param			data	body		api.ManualOutArgsUpdatePayload	true	"playbook"
+//	@Success		200		{object}	api.Execution
+//	@failure		400		{object}	api.Error
 //	@Router			/manual/continue [POST]
 func (manualHandler *ManualHandler) PostContinue(g *gin.Context) {
 

pkg/core/capability/manual/manual.go

@@ -20,7 +20,7 @@ var (
 
 const (
 	manualResultVariableName = "__soarca_manual_result__"
-	manualCapabilityName     = "soarca-manual-http"
+	manualCapabilityName     = "soarca-manual"
 	fallbackTimeout          = time.Minute * 1
 )
 
@@ -51,6 +51,7 @@ func (manual *ManualCapability) Execute(
 	}
 
 	timeout := manual.getTimeoutValue(commandContext.Step.Timeout)
+	log.Trace("timeout is set to: ", timeout)
 	ctx, cancel := context.WithTimeout(context.Background(), timeout)
 	defer cancel()
 

pkg/core/executors/action/action.go

@@ -45,6 +45,7 @@ type data struct {
 	target         cacao.AgentTarget
 	variables      cacao.Variables
 	agent          cacao.AgentTarget
+	step           cacao.Step
 }
 
 func (executor *Executor) Execute(meta execution.Metadata,
@@ -85,6 +86,7 @@ func (executor *Executor) executeCommandFromArray(meta execution.Metadata,
 				target:         target,
 				variables:      metadata.Variables,
 				agent:          metadata.Agent,
+				step:           metadata.Step,
 			}
 
 			outputVariables, err := executor.executeCommands(
@@ -156,6 +158,7 @@ func (executor *Executor) executeCommands(metadata execution.Metadata,
 		context.Target = interpolatedTarget(data.target, data.variables)
 		context.Authentication = interpolateAuthentication(data.authentication, data.variables)
 		context.Variables = data.variables
+		context.Step = data.step
 		returnVariables, err := capability.Execute(metadata, context)
 		return returnVariables, err
 	} else {

pkg/core/executors/action/action_executor_test.go

@@ -83,6 +83,7 @@ func TestExecuteStep(t *testing.T) {
 		Authentication: expectedAuth,
 		Target:         expectedTarget,
 		Variables:      cacao.NewVariables(expectedVariables),
+		Step:           step,
 	}
 
 	layout := "2006-01-02T15:04:05.000Z"