forked from splunk/security_content
-
Notifications
You must be signed in to change notification settings - Fork 0
/
risk_notable_preprocess.py
420 lines (290 loc) · 18.1 KB
/
risk_notable_preprocess.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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
"""
This playbook prepares a Risk Notable for investigation. First, it ensures that a "Risk Notable" links back to the original notable event with a card pinned to the HUD. It then posts a link to this container in the comment field of Enterprise Security. Finally, it updates the container name, description, and severity to reflect the data in the Notable artifact.\t
"""
import phantom.rules as phantom
import json
from datetime import datetime, timedelta
def on_start(container):
phantom.debug('on_start() called')
# call 'event_id_filter' block
event_id_filter(container=container)
return
def event_id_filter(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("event_id_filter() called")
################################################################################
# Only proceed if the event_id value is present. The event_id is also sometimes
# called a Notable ID.
################################################################################
# collect filtered artifact ids and results for 'if' condition 1
matched_artifacts_1, matched_results_1 = phantom.condition(
container=container,
conditions=[
["artifact:*.cef.event_id", "!=", ""]
],
name="event_id_filter:condition_1",
scope="all")
# call connected blocks if filtered artifacts or results
if matched_artifacts_1 or matched_results_1:
mark_evidence_artifact(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=matched_artifacts_1, filtered_results=matched_results_1)
# collect filtered artifact ids and results for 'if' condition 2
matched_artifacts_2, matched_results_2 = phantom.condition(
container=container,
logical_operator="and",
conditions=[
["artifact:*.cef.event_id", "!=", ""],
["artifact:*.name", "==", "Field Values"]
],
name="event_id_filter:condition_2",
scope="all")
# call connected blocks if filtered artifacts or results
if matched_artifacts_2 or matched_results_2:
artifact_update_notable(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=matched_artifacts_2, filtered_results=matched_results_2)
return
def artifact_update_notable(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("artifact_update_notable() called")
filtered_artifact_0_data_event_id_filter = phantom.collect2(container=container, datapath=["filtered-data:event_id_filter:condition_2:artifact:*.id"], scope="all")
parameters = []
# build parameters list for 'artifact_update_notable' call
for filtered_artifact_0_item_event_id_filter in filtered_artifact_0_data_event_id_filter:
parameters.append({
"name": "Notable Artifact",
"tags": None,
"label": None,
"severity": None,
"cef_field": None,
"cef_value": None,
"input_json": None,
"artifact_id": filtered_artifact_0_item_event_id_filter[0],
"cef_data_type": None,
})
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.custom_function(custom_function="community/artifact_update", parameters=parameters, name="artifact_update_notable")
return
def mark_evidence_artifact(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("mark_evidence_artifact() called")
id_value = container.get("id", None)
filtered_artifact_0_data_event_id_filter = phantom.collect2(container=container, datapath=["filtered-data:event_id_filter:condition_1:artifact:*.id"], scope="all")
parameters = []
# build parameters list for 'mark_evidence_artifact' call
for filtered_artifact_0_item_event_id_filter in filtered_artifact_0_data_event_id_filter:
parameters.append({
"container": id_value,
"content_type": "artifact_id",
"input_object": filtered_artifact_0_item_event_id_filter[0],
})
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.custom_function(custom_function="community/mark_evidence", parameters=parameters, name="mark_evidence_artifact", callback=asset_get_splunk)
return
def asset_get_splunk(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("asset_get_splunk() called")
parameters = []
parameters.append({
"asset": "splunk",
})
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.custom_function(custom_function="community/asset_get_attributes", parameters=parameters, name="asset_get_splunk", callback=asset_get_splunk_callback)
return
def asset_get_splunk_callback(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("asset_get_splunk_callback() called")
format_es_url(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=filtered_artifacts, filtered_results=filtered_results)
format_es_note(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=filtered_artifacts, filtered_results=filtered_results)
format_event_name(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=filtered_artifacts, filtered_results=filtered_results)
return
def format_es_url(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("format_es_url() called")
################################################################################
# Format a URL for the link back to the Notable ID. Change the port number as
# needed.
################################################################################
template = """https://{0}/en-US/app/SplunkEnterpriseSecuritySuite/incident_review?earliest={1}&latest=now&search=event_id%3D{2}"""
# parameter list for template variable replacement
parameters = [
"asset_get_splunk:custom_function_result.data.configuration.device",
"filtered-data:event_id_filter:condition_1:artifact:*.cef.info_min_time",
"filtered-data:event_id_filter:condition_1:artifact:*.cef.event_id"
]
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.format(container=container, template=template, parameters=parameters, name="format_es_url", scope="all")
pin_es_url(container=container)
return
def pin_es_url(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("pin_es_url() called")
################################################################################
# Pin the Enterprise Security URL
################################################################################
format_es_url = phantom.get_format_data(name="format_es_url")
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.pin(container=container, data=format_es_url, message="Enterprise Security URL", name="es_url", pin_style="grey", pin_type="card")
container = phantom.get_container(container.get('id', None))
return
def format_es_note(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("format_es_note() called")
################################################################################
# Format a note with the current event information.
################################################################################
template = """SOAR event created: {0}\nComplete details can be found here: {1}/summary/evidence"""
# parameter list for template variable replacement
parameters = [
"container:id",
"container:url"
]
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.format(container=container, template=template, parameters=parameters, name="format_es_note", scope="all")
update_notable(container=container)
return
def update_notable(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("update_notable() called")
# phantom.debug('Action: {0} {1}'.format(action['name'], ('SUCCEEDED' if success else 'FAILED')))
################################################################################
# Update the notable event in Enterprise Security with a link back to this container
################################################################################
filtered_artifact_0_data_event_id_filter = phantom.collect2(container=container, datapath=["filtered-data:event_id_filter:condition_1:artifact:*.cef.event_id"], scope="all")
format_es_note = phantom.get_format_data(name="format_es_note")
parameters = []
# build parameters list for 'update_notable' call
for filtered_artifact_0_item_event_id_filter in filtered_artifact_0_data_event_id_filter:
if filtered_artifact_0_item_event_id_filter[0] is not None:
parameters.append({
"status": "in progress",
"comment": format_es_note,
"event_ids": filtered_artifact_0_item_event_id_filter[0],
})
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.act("update event", parameters=parameters, name="update_notable", assets=["splunk"])
return
def format_event_name(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("format_event_name() called")
################################################################################
# Format the event name as 'Source: Risk Object'
################################################################################
template = """{0}: {1}"""
# parameter list for template variable replacement
parameters = [
"filtered-data:event_id_filter:condition_1:artifact:*.cef.source",
"filtered-data:event_id_filter:condition_1:artifact:*.cef.risk_object"
]
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.format(container=container, template=template, parameters=parameters, name="format_event_name", scope="all")
container_update_info(container=container)
return
def container_update_info(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("container_update_info() called")
id_value = container.get("id", None)
filtered_artifact_0_data_event_id_filter = phantom.collect2(container=container, datapath=["filtered-data:event_id_filter:condition_1:artifact:*.cef.urgency","filtered-data:event_id_filter:condition_1:artifact:*.cef.source"], scope="all")
format_event_name = phantom.get_format_data(name="format_event_name")
parameters = []
# build parameters list for 'container_update_info' call
for filtered_artifact_0_item_event_id_filter in filtered_artifact_0_data_event_id_filter:
parameters.append({
"name": format_event_name,
"tags": None,
"label": None,
"owner": None,
"status": None,
"severity": filtered_artifact_0_item_event_id_filter[0],
"input_json": None,
"description": filtered_artifact_0_item_event_id_filter[1],
"sensitivity": None,
"container_input": id_value,
})
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.custom_function(custom_function="community/container_update", parameters=parameters, name="container_update_info", callback=artifact_update_severity)
return
def artifact_update_severity(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("artifact_update_severity() called")
filtered_artifact_0_data_event_id_filter = phantom.collect2(container=container, datapath=["filtered-data:event_id_filter:condition_1:artifact:*.cef.urgency","filtered-data:event_id_filter:condition_1:artifact:*.id"], scope="all")
parameters = []
# build parameters list for 'artifact_update_severity' call
for filtered_artifact_0_item_event_id_filter in filtered_artifact_0_data_event_id_filter:
parameters.append({
"name": None,
"tags": None,
"label": None,
"severity": filtered_artifact_0_item_event_id_filter[0],
"cef_field": None,
"cef_value": None,
"input_json": None,
"artifact_id": filtered_artifact_0_item_event_id_filter[1],
"cef_data_type": None,
})
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.custom_function(custom_function="community/artifact_update", parameters=parameters, name="artifact_update_severity")
return
def on_finish(container, summary):
phantom.debug("on_finish() called")
################################################################################
## Custom Code Start
################################################################################
# This function is called after all actions are completed.
# summary of all the action and/or all details of actions
# can be collected here.
# summary_json = phantom.get_summary()
# if 'result' in summary_json:
# for action_result in summary_json['result']:
# if 'action_run_id' in action_result:
# action_results = phantom.get_action_results(action_run_id=action_result['action_run_id'], result_data=False, flatten=False)
# phantom.debug(action_results)
################################################################################
## Custom Code End
################################################################################
return