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.

Sign up for GitHub

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

Jump to bottom

[VIRTS-4153] ]Update server to account for exit_code from agent #2713

Merged
merged 5 commits into from
Feb 14, 2023
Merged

[VIRTS-4153] ]Update server to account for exit_code from agent #2713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
adad5f3
Update server to account for exit_code from agent
michael-the-jones Dec 23, 2022
b035308
Updated Operations UI to include exit codes
michael-the-jones Jan 13, 2023
8f7bc75
Merge branch 'master' into VIRTS-4153
mchan143 Feb 9, 2023
6d1c49c
Merge branch 'master' of github.com:mitre/caldera into VIRTS-4153
elegantmoose Feb 9, 2023
d18d0c1
styling
elegantmoose Feb 9, 2023
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 app/objects/secondclass/c_result.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ class ResultSchema(ma.Schema):
id = ma.fields.String()
output = ma.fields.String()
stderr = ma.fields.String()
exit_code = ma.fields.String()
pid = ma.fields.String()
status = ma.fields.String()
agent_reported_time = ma.fields.DateTime(format=BaseObject.TIME_FORMAT, missing=None)
Expand All @@ -26,11 +27,12 @@ class Result(BaseObject):

schema = ResultSchema()

def __init__(self, id, output, stderr="", pid=0, status=0, agent_reported_time=None):
def __init__(self, id, output, stderr='', exit_code='', pid=0, status=0, agent_reported_time=None):
super().__init__()
self.id = id
self.output = output
self.stderr = stderr
self.exit_code = exit_code
self.pid = pid
self.status = status
self.agent_reported_time = agent_reported_time
6 changes: 4 additions & 2 deletions app/service/contact_svc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,8 @@ async def _save(self, result):
result.output = await self._postprocess_link_result(result.output, link)
command_results = json.dumps(dict(
stdout=self.decode_bytes(result.output, strip_newlines=False),
stderr=self.decode_bytes(result.stderr, strip_newlines=False)))
stderr=self.decode_bytes(result.stderr, strip_newlines=False),
exit_code=result.exit_code))
encoded_command_results = self.encode_string(command_results)
self.get_service('file_svc').write_result_file(result.id, encoded_command_results)
operation = await self.get_service('app_svc').find_op_with_link(result.id)
Expand All @@ -145,7 +146,8 @@ async def _save(self, result):
else:
command_results = json.dumps(dict(
stdout=self.decode_bytes(result.output, strip_newlines=False),
stderr=self.decode_bytes(result.stderr, strip_newlines=False)))
stderr=self.decode_bytes(result.stderr, strip_newlines=False),
exit_code=result.exit_code))
encoded_command_results = self.encode_string(command_results)
self.get_service('file_svc').write_result_file(result.id, encoded_command_results)
except Exception as e:
Expand Down
4 changes: 2 additions & 2 deletions app/service/file_svc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,10 @@ def read_result_file(self, link_id, location='data/results'):
return decoded_buf
except json.JSONDecodeError:
results = json.dumps(dict(
stdout=self.decode_bytes(decoded_buf, strip_newlines=False), stderr=''))
stdout=self.decode_bytes(decoded_buf, strip_newlines=False), stderr='', exit_code=''))
return self.encode_string(str(results))
except binascii.Error:
results = json.dumps(dict(stdout=decoded_buf, stderr=''))
results = json.dumps(dict(stdout=decoded_buf, stderr='', exit_code=''))
return self.encode_string(str(results))

def write_result_file(self, link_id, output, location='data/results'):
Expand Down
5 changes: 3 additions & 2 deletions templates/operations.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,13 +427,14 @@ <h2>Operations</h2>
</div>
</template>
<div>
<p class="mt-3 mb-2" x-text="`Standard Output: ${selectedLinkResults.stdout ? '' : 'Nothing to show'}`"></p>
<p class="mt-3 mb-2" x-text="`Exit Code: ${selectedLinkResults && selectedLinkResults.exit_code ? selectedLinkResults.exit_code : 'Nothing to show'}`"></p>
<p class="mt-3 mb-2" x-text="`Standard Output: ${selectedLinkResults && selectedLinkResults.stdout ? '' : 'Nothing to show'}`"></p>
<template x-if="selectedLinkResults != null && selectedLinkResults.stdout !== ''">
<pre class="has-text-left white-space-pre-line" x-text="selectedLinkResults.stdout"></pre>
</template>
</div>
<div>
<p class="mt-3 mb-2" x-text="`Standard Error: ${selectedLinkResults.stderr ? '' : 'Nothing to show'}`"></p>
<p class="mt-3 mb-2" x-text="`Standard Error: ${selectedLinkResults && selectedLinkResults.stderr ? '' : 'Nothing to show'}`"></p>
<template x-if="selectedLinkResults != null && selectedLinkResults.stderr !== ''">
<pre class="has-text-left white-space-pre-line has-text-danger" x-text="selectedLinkResults.stderr"></pre>
</template>
Expand Down
6 changes: 6 additions & 0 deletions tests/services/test_contact_svc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,14 @@ class TestContactSvc:
async def test_save_ability_hooks(self, setup_contact_service, contact_svc, event_svc):
test_string = b'test_string'
err_string = b'err_string'
test_exit_code = "-1"
link = setup_contact_service
rest_svc = RestService()
result = dict(
id=link.id,
output=str(base64.b64encode(base64.b64encode(test_string)), 'utf-8'),
stderr=str(base64.b64encode(err_string), 'utf-8'),
exit_code=test_exit_code,
pid=0,
status=0
)
Expand All @@ -60,6 +62,7 @@ async def test_save_ability_hooks(self, setup_contact_service, contact_svc, even

assert result_dict['stdout'] == test_string.decode()
assert result_dict['stderr'] == err_string.decode()
assert result_dict['exit_code'] == test_exit_code

# cleanup test
try:
Expand All @@ -70,11 +73,13 @@ async def test_save_ability_hooks(self, setup_contact_service, contact_svc, even
async def test_save_ability_hooks_with_no_link(self, setup_contact_service, contact_svc, event_svc, file_svc):
test_string = b'test_string'
err_string = b'err_string'
test_exit_code = "0"
# Send version with link for comparison
result = dict(
id="12345",
output=str(base64.b64encode(test_string), 'utf-8'),
stderr=str(base64.b64encode(err_string), 'utf-8'),
exit_code=test_exit_code,
pid=0,
status=0
)
Expand All @@ -85,6 +90,7 @@ async def test_save_ability_hooks_with_no_link(self, setup_contact_service, cont
result_dict = json.loads(base64.b64decode(result))
assert result_dict['stdout'] == test_string.decode()
assert result_dict['stderr'] == err_string.decode()
assert result_dict['exit_code'] == test_exit_code

# cleanup test
try:
Expand Down
9 changes: 5 additions & 4 deletions tests/services/test_file_svc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,11 @@ def test_read_write_result_file(self, tmpdir, file_svc):
link_id = '12345'
output = 'output testing unit'
error = 'error testing unit'
output_encoded = str(b64encode(json.dumps(dict(stdout=output, stderr=error)).encode()), 'utf-8')
test_exit_code = '0'
output_encoded = str(b64encode(json.dumps(dict(stdout=output, stderr=error, exit_code=test_exit_code)).encode()), 'utf-8')
file_svc.write_result_file(link_id=link_id, output=output_encoded, location=tmpdir)

expected_output = dict(stdout=output, stderr=error)
expected_output = dict(stdout=output, stderr=error, exit_code=test_exit_code)
output_data = file_svc.read_result_file(link_id=link_id, location=tmpdir)
decoded_output_data = json.loads(base64.b64decode(output_data))
assert decoded_output_data == expected_output
Expand All @@ -68,7 +69,7 @@ def test_read_write_result_file_no_dict(self, tmpdir, file_svc):
output_encoded = str(b64encode(output.encode()), 'utf-8')
file_svc.write_result_file(link_id=link_id, output=output_encoded, location=tmpdir)

expected_output = {'stdout': output, 'stderr': ''}
expected_output = {'stdout': output, 'stderr': '', 'exit_code': ''}
output_data = file_svc.read_result_file(link_id=link_id, location=tmpdir)
decoded_output_data = json.loads(base64.b64decode(output_data))
assert decoded_output_data == expected_output
Expand All @@ -78,7 +79,7 @@ def test_read_write_result_file_no_base64(self, tmpdir, file_svc):
output = 'output testing unit'
file_svc.write_result_file(link_id=link_id, output=output, location=tmpdir)

expected_output = {'stdout': output, 'stderr': ''}
expected_output = {'stdout': output, 'stderr': '', 'exit_code': ''}
output_data = file_svc.read_result_file(link_id=link_id, location=tmpdir)
decoded_output_data = json.loads(base64.b64decode(output_data))
assert decoded_output_data == expected_output
Expand Down