Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bugfix/139 capabilities dont have the correct variable type on returning #140

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion internal/capability/http/http.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,9 @@ func (httpCapability *HttpCapability) Execute(
return cacao.NewVariables(), err
}
respString := string(responseBytes)
variable := cacao.Variable{Name: httpApiResultVariableName, Value: respString}
variable := cacao.Variable{Type: cacao.VariableTypeString,
Name: httpApiResultVariableName,
Value: respString}

return cacao.NewVariables(variable), nil

Expand Down
4 changes: 3 additions & 1 deletion internal/capability/openc2/openc2.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ func (OpenC2Capability *OpenC2Capability) Execute(
return cacao.NewVariables(), err
}

results := cacao.NewVariables(cacao.Variable{Name: openc2ResultVariableName, Value: string(response)})
results := cacao.NewVariables(cacao.Variable{Type: cacao.VariableTypeString,
Name: openc2ResultVariableName,
Value: string(response)})
log.Trace("Finished openc2 execution, will return the variables: ", results)
return results, nil
}
4 changes: 3 additions & 1 deletion internal/capability/ssh/ssh.go
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,9 @@ func (sshCapability *SshCapability) Execute(metadata execution.Metadata,
log.Error(err)
return cacao.NewVariables(), err
}
results := cacao.NewVariables(cacao.Variable{Name: sshResultVariableName, Value: string(response)})
results := cacao.NewVariables(cacao.Variable{Type: cacao.VariableTypeString,
Name: sshResultVariableName,
Value: string(response)})
log.Trace("Finished ssh execution will return the variables: ", results)
return results, err
}
Expand Down
8 changes: 4 additions & 4 deletions internal/fin/protocol/protocol.go
Original file line number Diff line number Diff line change
Expand Up @@ -83,15 +83,15 @@ func (protocol *FinProtocol) SendCommand(command fin.Command) (cacao.Variables,
err = protocol.Publish(client, command)
if err != nil {
protocol.Disconnect(client)
return map[string]cacao.Variable{}, err
return cacao.NewVariables(), err
}
result, err := protocol.AwaitResultOrTimeout(command, client)
protocol.Disconnect(client)

return result, err
}

func (protocol *FinProtocol) AwaitResultOrTimeout(command fin.Command, client mqttlib.Client) (map[string]cacao.Variable, error) {
func (protocol *FinProtocol) AwaitResultOrTimeout(command fin.Command, client mqttlib.Client) (cacao.Variables, error) {
timeout := command.CommandSubstructure.Context.Timeout

if command.CommandSubstructure.Context.Timeout == 0 {
Expand All @@ -107,7 +107,7 @@ func (protocol *FinProtocol) AwaitResultOrTimeout(command fin.Command, client mq
select {
case <-timer.C:
err := errors.New("no message received from fin while it was expected")
return map[string]cacao.Variable{}, err
return cacao.NewVariables(), err
case result := <-protocol.channel:
finMessage := fin.Message{}
err := fin.Decode(result, &finMessage)
Expand All @@ -124,7 +124,7 @@ func (protocol *FinProtocol) AwaitResultOrTimeout(command fin.Command, client mq
err := fin.Decode(result, &finResult)
if err != nil {
log.Trace(err)
return map[string]cacao.Variable{}, err
return cacao.NewVariables(), err
}

if ackReceived {
Expand Down
18 changes: 18 additions & 0 deletions models/cacao/cacao.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,24 @@ type Variable struct {
External bool `bson:"external,omitempty" json:"external,omitempty"`
}

const (
VariableTypeBool = "bool"
VariableTypeDictionary = "dictionary"
VariableTypeFloat = "float"
VariableTypeHexString = "hexstring"
VariableTypeInt = "integer"
VariableTypeIpv4Address = "ipv4-addr"
VariableTypeIpv6Address = "ipv6-addr"
VariableTypeLong = "long"
VariableTypeMacAddress = "mac-addr"
VariableTypeHash = "hash"
VariableTypeMd5Has = "md5-hash"
VariableTypeSha256 = "sha256-hash"
VariableTypeString = "string"
VariableTypeUri = "uri"
VariableTypeUuid = "uuid"
)

type Variables map[string]Variable

type Playbook struct {
Expand Down
6 changes: 3 additions & 3 deletions test/unittest/finprotocol/finprotocol_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func TestTimeoutAndCallbackTimerElaspsed(t *testing.T) {
result, err := prot.AwaitResultOrTimeout(expectedCommand, &mock_client)

assert.Equal(t, err, errors.New("no message received from fin while it was expected"))
assert.Equal(t, result, map[string]cacao.Variable{})
assert.Equal(t, result, cacao.NewVariables())
}

func TestTimeoutAndCallbackHandlerCalled(t *testing.T) {
Expand Down Expand Up @@ -76,7 +76,7 @@ func TestTimeoutAndCallbackHandlerCalled(t *testing.T) {
fmt.Println("done waiting")

assert.Equal(t, err, nil)
assert.Equal(t, result, map[string]cacao.Variable{"test": {Name: "test"}})
assert.Equal(t, result, cacao.NewVariables(cacao.Variable{Name: "test"}))
mock_client.AssertExpectations(t)
mock_token.AssertExpectations(t)
mock_token_ack.AssertExpectations(t)
Expand Down Expand Up @@ -106,7 +106,7 @@ func helper(prot *protocol.FinProtocol) {

result := fin.Result{}
result.Type = fin.MessageTypeResult
result.ResultStructure.Variables = map[string]cacao.Variable{"test": {Name: "test"}}
result.ResultStructure.Variables = cacao.NewVariables(cacao.Variable{Name: "test"})

payload, err := json.Marshal(result)
if err != nil {
Expand Down