Feature/204 add variables payload to trigger by UUID #206

MaartendeKruijf · 2024-08-02T18:32:36Z

No description provided.

cugu · 2024-08-05T01:25:39Z

routes/trigger/trigger_api.go

+		jsonData, err := io.ReadAll(context.Request.Body)
+		if err != nil {
+			log.Trace("Playbook trigger has failed to decode request body")
+			error.SendErrorResponse(context, http.StatusBadRequest, "Failed to decode request body", "POST /tirgger/playbook/"+id, "")


Suggested change

error.SendErrorResponse(context, http.StatusBadRequest, "Failed to decode request body", "POST /tirgger/playbook/"+id, "")

error.SendErrorResponse(context, http.StatusBadRequest, "Failed to decode request body", "POST /trigger/playbook/"+id, "")

lucamrgs · 2024-08-08T09:11:14Z

routes/trigger/trigger_api.go

+	}
+
+	if playbook.PlaybookVariables == nil {
+		playbook.PlaybookVariables = variables


Does this initialise a nil playbookVariables object? In that case, we might want to initialise an empty playbookVariables object instead, as per recent merge request - right?

I stand corrected, variables, is assigned. All good.

lucamrgs · 2024-08-08T09:30:27Z

routes/trigger/trigger_api.go

+	}
+
+	if playbook.PlaybookVariables == nil {
+		playbook.PlaybookVariables = variables


I stand corrected, variables, is assigned. All good.

lucamrgs · 2024-08-08T09:40:25Z

routes/trigger/trigger_api.go

@@ -43,6 +45,22 @@ func New(controller decomposer_controller.IController, database database.IContro
 	return &instance
 }

+func MergeVariablesInPlaybook(playbook *cacao.Playbook, body []byte) {


We should add a function that checks that all injected variables from the trigger API payload actually exist in the playbook variables, otherwise send back a bad request and not execute further

MaartendeKruijf · 2024-08-08T16:01:25Z

routes/trigger/trigger_api.go

@@ -43,6 +46,41 @@ func New(controller decomposer_controller.IController, database database.IContro
 	return &instance
 }

+func MergeVariablesInPlaybook(playbook *cacao.Playbook, body []byte) (bool, string) {


Return error instead of string

MaartendeKruijf · 2024-08-08T16:02:38Z

routes/trigger/trigger_api.go

+			}
+			// TODO: Exists, must not overwrite the external field
+			// Impossible to implement currently or it would break execution: new vars values are initialized to external: false, which means on injection
+			// they change the value of the variable currently there


Just add the value and description to the playbook.PlayboookVariables...

MaartendeKruijf · 2024-08-08T16:03:05Z

routes/trigger/trigger_api.go

-//	@Param			id	path		string	true	"playbook ID"
-//	@Success		200			{object}	api.Execution
-//	@failure		400			{object}	api.Error
+//	@Param			id		path		string			true	"playbook ID"


execute swag fmt

MaartendeKruijf · 2024-08-08T16:03:51Z

routes/trigger/trigger_api.go

+	// TODO: to change in documentation too. The variable must be provided as a valid { key: cacao.Variable} object,
+	// and the check on mathcing playbook variables must happen on the key.
+	// in the current code, we are wrongly assuming that the "name" of the variable, and the "key" in the playbook, match
+	payload_variables := cacao.NewVariables()


playbookVariables

Suggested change

payload_variables := cacao.NewVariables()

playbookVariables := cacao.NewVariables()

MaartendeKruijf · 2024-08-08T16:04:10Z

routes/trigger/trigger_api.go

+	}
+
+	// Check payload-injected variables are valid set for playbook variables
+	for k, payload_var := range payload_variables {


Suggested change

for k, payload_var := range payload_variables {

for name, variable := range payloadVariables {

MaartendeKruijf · 2024-08-14T11:12:58Z

routes/trigger/trigger_api.go

 	}
-
+	fmt.Println(playbook)


use log or remove

MaartendeKruijf · 2024-08-14T11:14:16Z

test/unittest/routes/trigger_api/tigger_api_test.go

+	assert.Equal(t, expected_message_not_in_pb, result_not_in_pb["message"].(string))
+
+	// ################################################################### Var is of wrong type
+	var_wrong_type := cacao.Variable{


Make this a separate test

MaartendeKruijf · 2024-08-14T11:14:25Z

test/unittest/routes/trigger_api/tigger_api_test.go

+	assert.Equal(t, 400, recorder_wrong_type.Code)
+	assert.Equal(t, expected_message_wrong_type, result_wrong_type["message"].(string))
+
+	// ################################################################### Playbook var is not external


Separate test

RabbITCybErSeC · 2024-08-15T13:30:07Z

test/unittest/routes/trigger_api/tigger_api_test.go

+	assert.Equal(t, 400, recorder_wrong_type.Code)
+
+	// Assertions
+	var result_wrong_type map[string]interface{}


are we using lowercase _?

RabbITCybErSeC · 2024-08-15T13:30:31Z

test/unittest/routes/trigger_api/tigger_api_test.go

+	mock_decomposer.AssertExpectations(t)
+}
+
+func TestExecutionOfPlaybookByIdWithPayloadInvalidVariables(t *testing.T) {


name is a bit long no?

routes/trigger/trigger_api.go

RabbITCybErSeC

General remark:

Maybe we should also change the naming in the test. It uses underscores right now.

RabbITCybErSeC · 2024-08-19T08:21:01Z

routes/trigger/trigger_api.go

 	id := context.Param("id")

 	db := trigger.database.GetDatabaseInstance()
 	playbook, err := db.Read(id)
 	if err != nil {
 		log.Error("failed to load playbook")
-		error.SendErrorResponse(context, http.StatusBadRequest,
+		soarca_http_error.SendErrorResponse(context, http.StatusBadRequest,


change soarca_http_error to something like SoarcaHttpError

RabbITCybErSeC · 2024-08-19T08:21:55Z

routes/trigger/trigger_api.go

+	if context.Request.Body != nil {
+		jsonData, err := io.ReadAll(context.Request.Body)
+		if err != nil {
+			log.Trace("Playbook trigger has failed to decode request body")


maybe to has failed to read request body

RabbITCybErSeC · 2024-08-19T08:23:24Z

routes/trigger/trigger_api.go

 			"Failed to marshall json on server side",
 			"POST /trigger/playbook", "")
 		return
 	}
 	// playbook := cacao.Decode(jsonData)
 	playbook := decoder.DecodeValidate(jsonData)
 	if playbook == nil {
-		error.SendErrorResponse(context, http.StatusBadRequest,
+		soarca_http_error.SendErrorResponse(context, http.StatusBadRequest,


change name no _ _ in name

RabbITCybErSeC · 2024-08-19T08:23:46Z

routes/trigger/trigger_api.go

+		case executionsDetail := <-trigger.ExecutionsChannel:
+			playbookId := executionsDetail.PlaybookId
+			executionId := executionsDetail.ExecutionId
+			if playbookId == playbook.ID {
 				msg := gin.H{


maybe we should make a model for this?

for the msg

Approved by JP and addressed issues

MaartendeKruijf added the enhancement New feature or request label Aug 2, 2024

MaartendeKruijf requested review from RabbITCybErSeC and lucamrgs August 2, 2024 18:32

MaartendeKruijf self-assigned this Aug 2, 2024

MaartendeKruijf linked an issue Aug 2, 2024 that may be closed by this pull request

Add variables payload to trigger by uuid #204

Closed

cugu reviewed Aug 5, 2024

View reviewed changes

MaartendeKruijf force-pushed the feature/204-add-variables-payload-to-trigger-by-uuid branch from ffa60d5 to 5bdbf5c Compare August 8, 2024 09:09

lucamrgs requested changes Aug 8, 2024

View reviewed changes

lucamrgs approved these changes Aug 8, 2024

View reviewed changes

lucamrgs previously requested changes Aug 8, 2024

View reviewed changes

MaartendeKruijf commented Aug 8, 2024

View reviewed changes

lucamrgs mentioned this pull request Aug 8, 2024

soarca-initialized variable properties overwrite playbook variable properties #211

Closed

MaartendeKruijf commented Aug 14, 2024

View reviewed changes

RabbITCybErSeC requested changes Aug 15, 2024

View reviewed changes

MaartendeKruijf and others added 9 commits August 16, 2024 16:24

Updated trigger api with variables

9db1e39

Guard playbookvariables

3056af3

Updated test

51abe18

Fixed typo in error message

6447884

guard variables injection on trigger by id payload

c0572ad

add note on variable merging inconsistency

8786143

fix issues with variables API injection inconsistencies

bc3a3e1

fix trigger api test due to changed string now all passes

12f45ec

change return type to error of mergeVariablesInPlaybook in trigger api

8ea7d52

MaartendeKruijf force-pushed the feature/204-add-variables-payload-to-trigger-by-uuid branch from 34da841 to 8ea7d52 Compare August 16, 2024 14:24

MaartendeKruijf added 3 commits August 16, 2024 16:38

Fixed variable naming style

b56ddf8

Fixed naming in test

4f242e3

fixed refactoring error

88d53b8

RabbITCybErSeC requested changes Aug 19, 2024

View reviewed changes

Refactored trigger_api code

ac0a768

MaartendeKruijf marked this pull request as ready for review August 20, 2024 08:56

MaartendeKruijf requested review from RabbITCybErSeC and lucamrgs August 21, 2024 07:57

RabbITCybErSeC approved these changes Aug 21, 2024

View reviewed changes

MaartendeKruijf merged commit 27f6f04 into development Aug 21, 2024
9 checks passed

MaartendeKruijf deleted the feature/204-add-variables-payload-to-trigger-by-uuid branch August 21, 2024 08:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/204 add variables payload to trigger by UUID #206

Feature/204 add variables payload to trigger by UUID #206

MaartendeKruijf commented Aug 2, 2024

cugu Aug 5, 2024

lucamrgs Aug 8, 2024

lucamrgs Aug 8, 2024

lucamrgs Aug 8, 2024

lucamrgs Aug 8, 2024

MaartendeKruijf Aug 8, 2024

MaartendeKruijf Aug 8, 2024

MaartendeKruijf Aug 8, 2024

MaartendeKruijf Aug 8, 2024

MaartendeKruijf Aug 8, 2024

MaartendeKruijf Aug 14, 2024

MaartendeKruijf Aug 14, 2024

MaartendeKruijf Aug 14, 2024

RabbITCybErSeC Aug 15, 2024

RabbITCybErSeC Aug 15, 2024

RabbITCybErSeC left a comment

RabbITCybErSeC Aug 19, 2024

RabbITCybErSeC Aug 19, 2024

RabbITCybErSeC Aug 19, 2024

RabbITCybErSeC Aug 19, 2024

RabbITCybErSeC Aug 19, 2024

	error.SendErrorResponse(context, http.StatusBadRequest, "Failed to decode request body", "POST /tirgger/playbook/"+id, "")
	error.SendErrorResponse(context, http.StatusBadRequest, "Failed to decode request body", "POST /trigger/playbook/"+id, "")

	payload_variables := cacao.NewVariables()
	playbookVariables := cacao.NewVariables()

	for k, payload_var := range payload_variables {
	for name, variable := range payloadVariables {

Feature/204 add variables payload to trigger by UUID #206

Feature/204 add variables payload to trigger by UUID #206

Conversation

MaartendeKruijf commented Aug 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RabbITCybErSeC left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment