This repository has been archived by the owner on Apr 12, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 11
/
insight_idr.py
205 lines (197 loc) · 8.87 KB
/
insight_idr.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
from sigma.processing.conditions import IncludeFieldCondition, MatchStringCondition, LogsourceCondition, RuleProcessingItemAppliedCondition
from sigma.processing.pipeline import ProcessingItem, ProcessingPipeline
from sigma.processing.transformations import ChangeLogsourceTransformation, RuleFailureTransformation, DetectionItemFailureTransformation, FieldMappingTransformation
from sigma.pipelines.common import logsource_windows_network_connection,logsource_windows_network_connection_initiated, logsource_windows_process_creation, logsource_windows_dns_query
def logsource_generic_dns_query() -> LogsourceCondition:
return LogsourceCondition(
category="dns"
)
def logsource_web_proxy() -> LogsourceCondition:
return LogsourceCondition(
category="proxy"
)
def logsource_firewall() -> LogsourceCondition:
return LogsourceCondition(
category="firewall"
)
def insight_idr_pipeline():
return ProcessingPipeline(
name="Generic Log Sources to Rapid7 InsightIDR Transformation",
priority=10,
items=[
# Process Creation field mapping
ProcessingItem(
identifier="insight_idr_process_creation_fieldmapping",
transformation=FieldMappingTransformation({
"ProcessId": "process.pid",
"Image": "process.exe_path",
"FileVersion": "process.exe_file.version",
"Description": "process.exe_file.description",
"Product": "process.exe_file.product_name",
"Company": "process.exe_file.author",
"OriginalFileName": "process.name",
"CommandLine": "process.cmd_line",
"User": "process.username",
"ParentProcessId": "parent_process.pid",
"ParentImage": "parent_process.exe_path",
"ParentCommandLine": "parent_process.cmd_line",
"ParentUser": "parent_process.username",
"md5": "process.exe_file.hashes.md5",
"sha1": "process.exe_file.hashes.sha1",
"sha256": "process.exe_file.hashes.sha256"
}),
rule_conditions=[
logsource_windows_process_creation(),
]
),
# Handle unsupported Process Start fields
ProcessingItem(
identifier="insight_idr_fail_process_start_fields",
transformation=DetectionItemFailureTransformation("The InsightIDR backend does not support the CurrentDirectory, IntegrityLevel, or imphash fields for process start rules."),
rule_conditions=[
logsource_windows_process_creation()
],
detection_item_conditions=[
IncludeFieldCondition(
fields=[
"CurrentDirectory",
"IntegrityLevel",
"imphash",
"LogonId"
]
)
]
),
# Change logsource properties
ProcessingItem(
identifier="insight_idr_process_start_logsource",
transformation=ChangeLogsourceTransformation(
category="process_start_event",
product="windows"
),
rule_conditions=[
logsource_windows_process_creation(),
]
),
# DNS Request field mapping
ProcessingItem(
identifier="insight_idr_dns_query_fieldmapping",
transformation=FieldMappingTransformation({
"QueryName": "query",
"Computer": "asset"
}),
rule_conditions=[
logsource_windows_dns_query(),
]
),
# Handle unsupported DNS query fields
ProcessingItem(
identifier="insight_idr_fail_dns_fields",
rule_condition_linking=any,
transformation=DetectionItemFailureTransformation("The InsightIDR backend does not support the ProcessID, QueryStatus, QueryResults, or Image fields for DNS events."),
rule_conditions=[
logsource_windows_dns_query(),
logsource_generic_dns_query()
],
detection_item_conditions=[
IncludeFieldCondition(
fields=[
"ProcessId",
"QueryStatus",
"QueryResults",
"Image"
]
)
]
),
# Change log source properties
ProcessingItem(
identifier="insight_idr_dns_query_logsource",
rule_condition_linking=any,
transformation=ChangeLogsourceTransformation(
category="dns"
),
rule_conditions=[
logsource_windows_dns_query(),
logsource_generic_dns_query()
]
),
# Web Proxy field mapping
ProcessingItem(
identifier="insight_idr_web_proxy_fieldmapping",
transformation=FieldMappingTransformation({
"c-uri": "url",
"c-uri-query": "url_path",
"cs-bytes": "incoming_bytes",
"cs-host": "url_host",
"cs-method": "http_method",
"r-dns": "url_host",
"sc-bytes": "outgoing_bytes",
"src_ip": "source_ip",
"dst_ip": "destination_ip"
}),
rule_conditions=[
logsource_web_proxy(),
]
),
# Handle unsupported Web Proxy event fields
ProcessingItem(
identifier="insight_idr_fail_web_proxy_fields",
rule_condition_linking=all,
transformation=DetectionItemFailureTransformation("The InsightIDR backend does not support the c-uri-extension, c-uri-stem, c-useragent, cs-cookie, cs-referrer, cs-version, or sc-status fields for web proxy events."),
rule_conditions=[
logsource_web_proxy()
],
detection_item_conditions=[
IncludeFieldCondition(
fields=[
"c-uri-extension",
"c-uri-stem",
"c-useragent",
"cs-referrer",
"cs-version",
"sc-status"
]
)
]
),
# Change logsource property
ProcessingItem(
identifier="insight_idr_web_proxy_logsource",
transformation=ChangeLogsourceTransformation(
category="web_proxy"
),
rule_conditions=[
logsource_web_proxy(),
]
),
# Firewall - this is a placeholder. Firewall rules not yet supported :(
ProcessingItem(
identifier="insight_idr_firewall_fieldmapping",
transformation=FieldMappingTransformation({
"src_ip": "source_address",
"src_port": "source_port",
"dst_ip": "destination_address",
"dst_port": "destination_port",
"username": "user"
}),
rule_conditions=[
logsource_firewall(),
]
),
# Handle unsupported log sources - here we are checking whether none of the log source-specific transformations
# that were set above have applied and throwing a RuleFailureTransformation error if this condition is met. Otherwise,
# a separate processing item would be needed for every unsupported log source type
ProcessingItem(
identifier="insight_idr_fail_rule_not_supported",
rule_condition_linking=any,
transformation=RuleFailureTransformation("Rule type not yet supported by the InsightIDR Sigma backend!"),
rule_condition_negation=True,
rule_conditions=[
RuleProcessingItemAppliedCondition("insight_idr_web_proxy_logsource"),
RuleProcessingItemAppliedCondition("insight_idr_process_start_logsource"),
RuleProcessingItemAppliedCondition("insight_idr_dns_query_logsource")
],
)
]
)