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

Add the possibility to add tags, tlp, and message in TheHive observables #873

Merged
merged 12 commits into from
Jun 1, 2022
Merged

Add the possibility to add tags, tlp, and message in TheHive observables #873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
208f444
Add the possibility to add tags, tlp, and message in TheHive observables
May 31, 2022
83bdf14
add explanation on changelog.md
May 31, 2022
ebbe5da
modification of the documentation to use the tlp, message and tags fi…
May 31, 2022
88ad02c
modification of unit test to take into account that the observable ma…
May 31, 2022
41090ca
modification of unit test to take into account that the observable ma…
May 31, 2022
cc041a6
fix expected value in test_load_observables
May 31, 2022
0fb682e
add author in changelogs
May 31, 2022
0cbe579
small fix in doc ruletype.rst
Jun 1, 2022
823cb0f
small fix in doc ruletype.rst
Jun 1, 2022
82bcd1b
fix typo issue in the_hive_test
Jun 1, 2022
9ce64e2
fix typo issue in the_hive_test
Jun 1, 2022
aa1629e
Correct grammer/spelling.
jertel Jun 1, 2022
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
- Add support for Kibana 8.2 for Kibana Discover, Upgrade Pytest 7.1.1 to 7.1.2, Upgrade pylint 2.13.5 to 2.13.8, Upgrade Jinja2 3.1.1 to 3.1.2 - [#840](https://github.com/jertel/elastalert2/pull/840) - @nsano-rururu
- Add the possibility to use rule and match fields in the description of TheHive alerts - [#855](https://github.com/jertel/elastalert2/pull/855) - @luffynextgen
- Fix missing colon on schema.yml and add unit test on it - [#866](https://github.com/jertel/elastalert2/pull/866) - @Isekai-Seikatsu
- Add the possibility to use tags, message and tlp level in TheHive observables [#873](https://github.com/jertel/elastalert2/pull/873) - @luffynextgen

# 2.5.0

Expand Down
10 changes: 8 additions & 2 deletions docs/source/ruletypes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3225,8 +3225,9 @@ using the first matched record, before checking the rule. If neither matches, th
will be used directly.

``hive_observable_data_mapping``: If needed, matched data fields can be mapped to TheHive
observable types using the same syntax as ``tags``, described above. The algorithm used to populate
the observable value is also the same, including the behaviour for aggregated alerts.
observable types using the same syntax as ``customFields``, described above. The algorithm used to populate
the observable value is similar to the one used to populate the ``tags``, including the behaviour for aggregated alerts.
The tlp, message, and tags fields are optional for each observable. If not specified, the tlp field is given a default value of 2.

``hive_proxies``: Proxy configuration.

Expand Down Expand Up @@ -3265,7 +3266,12 @@ Example usage::

hive_observable_data_mapping:
- domain: agent.hostname
tlp: 1
tags: ['tag1', 'tag2']
message: 'agent hostname'
- domain: response.domain
tlp: 2
tags: ['tag3']
- ip: client.ip

Twilio
Expand Down
25 changes: 16 additions & 9 deletions elastalert/alerters/thehive.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,22 @@ def load_observable_artifacts(self, match: dict):
artifacts = []
for mapping in self.rule.get('hive_observable_data_mapping', []):
for observable_type, mapping_key in mapping.items():
data = str(self.lookup_field(match, mapping_key, ''))
if len(data) != 0:
artifact = {'tlp': 2,
'tags': [],
'message': None,
'dataType': observable_type,
'data': data}
artifacts.append(artifact)

if (observable_type != "tlp" and observable_type != "message" and observable_type != "tags"):
data = str(self.lookup_field(match, mapping_key, ''))
if len(data) != 0:
artifact = {'tlp': 2,
'tags': [],
'message': None,
'dataType': observable_type,
'data': data}
if mapping.get('tlp') is not None:
artifact['tlp'] = mapping['tlp']
if mapping.get('message') is not None:
artifact['message'] = mapping['message']
if mapping.get('tags') is not None:
artifact['tags'] = mapping['tags']
artifacts.append(artifact)
break
return artifacts

def load_custom_fields(self, custom_fields_raw: list, match: dict):
Expand Down
70 changes: 63 additions & 7 deletions tests/alerters/thehive_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def test_thehive_alerter(caplog):
'hive_connection': {'hive_apikey': '',
'hive_host': 'https://localhost',
'hive_port': 9000},
'hive_observable_data_mapping': [{'ip': 'test.ip', 'autonomous-system': 'test.as_number'}],
'hive_observable_data_mapping': [{'ip': 'test.ip'}, {'autonomous-system': 'test.as_number'}],
'name': 'test-thehive',
'tags': ['a', 'b'],
'type': 'any'}
Expand Down Expand Up @@ -194,7 +194,7 @@ def test_thehive_alerter2():
'hive_connection': {'hive_apikey': '',
'hive_host': 'https://localhost',
'hive_port': 9000},
'hive_observable_data_mapping': [{'ip': 'test.ip', 'autonomous-system': 'test.as_number'}],
'hive_observable_data_mapping': [{'ip': 'test.ip'}, {'autonomous-system': 'test.as_number'}],
'name': 'test-thehive',
'tags': ['a', 'b'],
'type': 'any'}
Expand Down Expand Up @@ -291,7 +291,7 @@ def test_load_tags(tags, expect):
'hive_connection': {'hive_apikey': '',
'hive_host': 'https://localhost',
'hive_port': 9000},
'hive_observable_data_mapping': [{'ip': 'test.ip', 'autonomous-system': 'test.as_number'}],
'hive_observable_data_mapping': [{'ip': 'test.ip'}, {'autonomous-system': 'test.as_number'}],
'name': 'test-thehive',
'tags': ['a', 'b'],
'type': 'any'}
Expand Down Expand Up @@ -324,7 +324,7 @@ def test_load_description_default():
'hive_connection': {'hive_apikey': '',
'hive_host': 'https://localhost',
'hive_port': 9000},
'hive_observable_data_mapping': [{'ip': 'test.ip', 'autonomous-system': 'test.as_number'}],
'hive_observable_data_mapping': [{'ip': 'test.ip'}, {'autonomous-system': 'test.as_number'}],
'name': 'test-thehive',
'tags': ['a', 'b'],
'type': 'any'}
Expand Down Expand Up @@ -366,7 +366,7 @@ def test_load_description_no_args():
'hive_connection': {'hive_apikey': '',
'hive_host': 'https://localhost',
'hive_port': 9000},
'hive_observable_data_mapping': [{'ip': 'test.ip', 'autonomous-system': 'test.as_number'}],
'hive_observable_data_mapping': [{'ip': 'test.ip'}, {'autonomous-system': 'test.as_number'}],
'name': 'test-thehive',
'tags': ['a', 'b'],
'type': 'any'}
Expand Down Expand Up @@ -411,7 +411,7 @@ def test_load_description_args():
'hive_connection': {'hive_apikey': '',
'hive_host': 'https://localhost',
'hive_port': 9000},
'hive_observable_data_mapping': [{'ip': 'test.ip', 'autonomous-system': 'test.as_number'}],
'hive_observable_data_mapping': [{'ip': 'test.ip'}, {'autonomous-system': 'test.as_number'}],
'name': 'test-thehive',
'tags': ['a', 'b'],
'type': 'any'}
Expand Down Expand Up @@ -454,7 +454,7 @@ def test_load_description_missing_value_default():
'hive_connection': {'hive_apikey': '',
'hive_host': 'https://localhost',
'hive_port': 9000},
'hive_observable_data_mapping': [{'ip': 'test.ip', 'autonomous-system': 'test.as_number'}],
'hive_observable_data_mapping': [{'ip': 'test.ip'}, {'autonomous-system': 'test.as_number'}],
'name': 'test-thehive',
'tags': ['a', 'b'],
'type': 'any'}
Expand All @@ -473,3 +473,59 @@ def test_load_description_missing_value_default():
actual = alert.load_description(rule['hive_alert_config']['description'], match)
expected = "Unit test from host:<MISSING VALUE> to 127.0.0.1"
assert actual == expected


def test_load_observable_artifacts():
rule = {'alert': [],
'alert_text': '',
'alert_text_type': 'alert_text_only',
'title': 'Unit test',
'description': 'test',
'hive_alert_config': {'customFields': [{'name': 'test',
'type': 'string',
'value': 2}],
'follow': True,
'severity': 2,
'source': 'elastalert',
'description_args': ['title', 'test.ip', 'host'],
'description': '{0} from host:{2} to {1}',
'status': 'New',
'tags': ['test.port'],
'tlp': 3,
'type': 'external'},
'hive_connection': {'hive_apikey': '',
'hive_host': 'https://localhost',
'hive_port': 9000},
'hive_observable_data_mapping': [
{'ip': 'test.ip', 'tlp': 1, 'tags': ['ip', 'test'], 'message': 'test tags'},
{'autonomous-system': 'test.as_number', 'tlp': 2, 'tags': ['autonomous']},
{'username': 'user.name', 'tlp': 1}, {'filename': 'process.name'}, {'ip': 'destination.ip'}
],
'name': 'test-thehive',
'tags': ['a', 'b'],
'type': 'any'}
rules_loader = FileRulesLoader({})
rules_loader.load_modules(rule)
alert = HiveAlerter(rule)
match = {
"test": {
"ip": "127.0.0.1",
"port": 9876,
"as_number": 1234
},
"user": {
"name": "toto"
},
"process": {
"name": "mstc.exe"
},
"@timestamp": "2021-05-09T14:43:30",
}
actual = alert.load_observable_artifacts(match)
expected = [
{'tlp': 1, 'tags': ['ip', 'test'], 'message': 'test tags', 'dataType': 'ip', 'data': '127.0.0.1'},
{'tlp': 2, 'tags': ['autonomous'], 'message': None, 'dataType': 'autonomous-system', 'data': '1234'},
{'tlp': 1, 'tags': [], 'message': None, 'dataType': 'username', 'data': 'toto'},
{'tlp': 2, 'tags': [], 'message': None, 'dataType': 'filename', 'data': 'mstc.exe'}
]
assert actual == expected