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

PantherFlow Investigator Helper #1436

Merged
merged 4 commits into from
Dec 4, 2024
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
48 changes: 48 additions & 0 deletions global_helpers/global_helpers_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -2391,5 +2391,53 @@ def test_change_filed_is_empty_on_update_context(self):
)


class TestPantherFlowInvestigation(unittest.TestCase):
def test_pantherflow_investigation(self):
# pylint: disable=line-too-long
event = {
"p_any_ip_addresses": ["12.34.56.78"],
"p_source_file": {
"aws_s3_bucket": "threat-research-trail-trail-bucket-0ipb5nzxam",
"aws_s3_key": "AWSLogs/123456789123/CloudTrail/us-east-1/2024/11/25/123456789123_CloudTrail_us-east-1_20241125T1505Z_XLixf09QqBSOD7c4.json.gz",
},
"p_any_trace_ids": ["ASIAQWERTYUIOPASDFGH"],
"p_any_actor_ids": ["AROAQWERTYUIOPASDFGH", "AROAQWERTYUIOPASDFGH:bob.ross"],
"p_any_aws_account_ids": ["123456789123"],
"p_any_aws_arns": [
"arn:aws:iam::123456789123:role/aws-reserved/sso.amazonaws.com/AWSReservedSSO_DevAdmin",
"arn:aws:sts::123456789123:assumed-role/AWSReservedSSO_DevAdmin/bob.ross",
"arn:aws:iam::123456789123:role/aws-reserved/sso.amazonaws.com/us-west-2/AWSReservedSSO_DevAdmin",
],
"p_any_usernames": ["AWSReservedSSO_DevAdmin", "bob.ross"],
"p_event_time": "2024-11-25 15:00:21.000000",
"p_log_type": "AWS.CloudTrail",
"p_parse_time": "2024-11-25 15:05:54.123385",
"p_row_id": "d66379c617d1f7b3b2e7ce9623c104",
"p_schema_version": 0,
"p_source_id": "d0a1e235-6548-4e7f-952a-35063b304007",
"p_source_label": "threat-research-trail-us-east-1",
"p_udm": {
"source": {"address": "12.34.56.78", "ip": "12.34.56.78"},
"user": {
"arns": [
"arn:aws:iam::123456789123:role/aws-reserved/sso.amazonaws.com/AWSReservedSSO_DevAdmin",
"arn:aws:sts::123456789123:assumed-role/AWSReservedSSO_DevAdmin/bob.ross",
]
},
},
}
event = ImmutableCaseInsensitiveDict(event)
query = """union panther_signals.public.correlation_signals
, panther_logs.public.aws_cloudtrail
| where p_event_time between datetime('2024-11-25 15:00:21.000000') - time.parse_timespan('30m') .. datetime('2024-11-25 15:00:21.000000') + time.parse_timespan('30m')
| where arrays.overlap(p_any_ip_addresses, ['12.34.56.78'])
or arrays.overlap(p_any_trace_ids, ['ASIAQWERTYUIOPASDFGH'])
or arrays.overlap(p_any_actor_ids, ['AROAQWERTYUIOPASDFGH', 'AROAQWERTYUIOPASDFGH:bob.ross'])
or arrays.overlap(p_any_aws_arns, ['arn:aws:iam::123456789123:role/aws-reserved/sso.amazonaws.com/AWSReservedSSO_DevAdmin', 'arn:aws:sts::123456789123:assumed-role/AWSReservedSSO_DevAdmin/bob.ross', 'arn:aws:iam::123456789123:role/aws-reserved/sso.amazonaws.com/us-west-2/AWSReservedSSO_DevAdmin'])
or arrays.overlap(p_any_usernames, ['AWSReservedSSO_DevAdmin', 'bob.ross'])
| sort p_event_time"""
self.assertEqual(p_b_h.pantherflow_investigation(event), query)


if __name__ == "__main__":
unittest.main()
2 changes: 2 additions & 0 deletions global_helpers/panther_aws_helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
from typing import Any, Dict, List

import boto3
from panther_base_helpers import pantherflow_investigation
from panther_config import config


Expand Down Expand Up @@ -38,6 +39,7 @@ def aws_rule_context(event):
"sourceIPAddress": event.get("sourceIPAddress", "<MISSING_SOURCE_IP>"),
"userAgent": event.get("userAgent", "<MISSING_USER_AGENT>"),
"userIdentity": event.get("userIdentity", "<MISSING_USER_IDENTITY>"),
"PantherFlow Investigation": pantherflow_investigation(event),
}


Expand Down
23 changes: 23 additions & 0 deletions global_helpers/panther_base_helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -327,3 +327,26 @@ def add_parse_delay(event, context: dict) -> dict:
parsing_delay = time_delta(event.get("p_event_time"), event.get("p_parse_time"))
context["parseDelay"] = f"{parsing_delay}"
return context


# generate a PantherFlow investigation from an event
def pantherflow_investigation(event, interval="30m"):
logtype = event.get("p_log_type", "").lower().replace(".", "_")
timestamp = event.get("p_event_time", "")

query = f"""union panther_signals.public.correlation_signals
, panther_logs.public.{logtype}
| where p_event_time between datetime('{timestamp}') - time.parse_timespan('{interval}') .. datetime('{timestamp}') + time.parse_timespan('{interval}')
"""

first = True
for key, value in event.items():
if key.startswith("p_any_") and key != "p_any_aws_account_ids":
if first:
query += f"| where arrays.overlap({key}, {value.copy()})\n"
first = False
else:
query += f" or arrays.overlap({key}, {value.copy()})\n"
query += "| sort p_event_time"

return query
4 changes: 4 additions & 0 deletions global_helpers/panther_okta_helpers.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
from panther_base_helpers import pantherflow_investigation


def okta_alert_context(event):
"""Returns common context for automation of Okta alerts"""
return {
Expand All @@ -12,4 +15,5 @@ def okta_alert_context(event):
"authentication_context": event.get("authenticationcontext", {}),
"security_context": event.get("securitycontext", {}),
"ips": event.get("p_any_ip_addresses", []),
"PantherFlow Investigation": pantherflow_investigation(event),
}
Loading