-
Notifications
You must be signed in to change notification settings - Fork 1
/
Jan 23 lab demo.py
466 lines (318 loc) · 19.8 KB
/
Jan 23 lab demo.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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
"""
"""
import phantom.rules as phantom
import json
from datetime import datetime, timedelta
def on_start(container):
phantom.debug('on_start() called')
# call 'list_merge_4' block
list_merge_4(container=container)
return
def geolocate_ip_1(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("geolocate_ip_1() called")
# phantom.debug('Action: {0} {1}'.format(action['name'], ('SUCCEEDED' if success else 'FAILED')))
list_merge_4_data = phantom.collect2(container=container, datapath=["list_merge_4:custom_function_result.data.*.item"])
parameters = []
# build parameters list for 'geolocate_ip_1' call
for list_merge_4_data_item in list_merge_4_data:
if list_merge_4_data_item[0] is not None:
parameters.append({
"ip": list_merge_4_data_item[0],
})
################################################################################
## Custom Code Start
################################################################################
phantom.debug(parameters)
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.act("geolocate ip", parameters=parameters, name="geolocate_ip_1", assets=["maxmind"], callback=geolocate_ip_1_callback)
return
def geolocate_ip_1_callback(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("geolocate_ip_1_callback() called")
debug_1(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=filtered_artifacts, filtered_results=filtered_results)
filter_out_none(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=filtered_artifacts, filtered_results=filtered_results)
return
def debug_1(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("debug_1() called")
name_value = container.get("name", None)
owner_name_value = container.get("owner_name", None)
geolocate_ip_1_result_data = phantom.collect2(container=container, datapath=["geolocate_ip_1:action_result.data.*.country_name","geolocate_ip_1:action_result.data.*.latitude","geolocate_ip_1:action_result.data.*.longitude","geolocate_ip_1:action_result.parameter.context.artifact_id"], action_results=results)
container_artifact_data = phantom.collect2(container=container, datapath=["artifact:*.cef.sourceAddress","artifact:*.id"])
geolocate_ip_1_result_item_0 = [item[0] for item in geolocate_ip_1_result_data]
geolocate_ip_1_result_item_1 = [item[1] for item in geolocate_ip_1_result_data]
geolocate_ip_1_result_item_2 = [item[2] for item in geolocate_ip_1_result_data]
container_artifact_cef_item_0 = [item[0] for item in container_artifact_data]
parameters = []
parameters.append({
"input_1": geolocate_ip_1_result_item_0,
"input_2": geolocate_ip_1_result_item_1,
"input_3": geolocate_ip_1_result_item_2,
"input_4": name_value,
"input_5": owner_name_value,
"input_6": container_artifact_cef_item_0,
"input_7": None,
"input_8": None,
"input_9": None,
"input_10": None,
})
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.custom_function(custom_function="community/debug", parameters=parameters, name="debug_1", callback=decision_1)
return
def prompt_2(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("prompt_2() called")
# set user and message variables for phantom.prompt call
user = "Administrator"
message = """The event {0} with severity {1}\n\nIP(s) are outside of our list\n\n{2}\n"""
# parameter list for template variable replacement
parameters = [
"container:name",
"container:severity",
"format_ip_and_country_list:formatted_data"
]
# responses
response_types = [
{
"prompt": "Would you like to change severity to High?",
"options": {
"type": "list",
"choices": [
"Yes",
"No"
],
},
},
{
"prompt": "Please provide an email address",
"options": {
"type": "message",
},
}
]
phantom.prompt2(container=container, user=user, message=message, respond_in_mins=1, name="prompt_2", parameters=parameters, response_types=response_types, callback=decision_3)
return
def decision_3(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("decision_3() called")
# check for 'if' condition 1
found_match_1 = phantom.decision(
container=container,
conditions=[
["prompt_2:action_result.summary.responses.0", "!=", "No"]
])
# call connected blocks if condition 1 matched
if found_match_1:
playbook_jan_24_child_demo_1(action=action, success=success, container=container, results=results, handle=handle)
return
return
def filter_out_none(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("filter_out_none() called")
# collect filtered artifact ids and results for 'if' condition 1
matched_artifacts_1, matched_results_1 = phantom.condition(
container=container,
conditions=[
["geolocate_ip_1:action_result.data.*.country_name", "!=", ""]
],
name="filter_out_none:condition_1")
# call connected blocks if filtered artifacts or results
if matched_artifacts_1 or matched_results_1:
country_filter(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,
conditions=[
["geolocate_ip_1:action_result.data.*.country_name", "==", ""]
],
name="filter_out_none:condition_2")
# call connected blocks if filtered artifacts or results
if matched_artifacts_2 or matched_results_2:
pin_5(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=matched_artifacts_2, filtered_results=matched_results_2)
return
def format_ip_and_country_list(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("format_ip_and_country_list() called")
template = """%%\nip: {0} is from {1}\n%%"""
# parameter list for template variable replacement
parameters = [
"filtered-data:filter_out_none:condition_1:geolocate_ip_1:action_result.parameter.ip",
"filtered-data:filter_out_none:condition_1:geolocate_ip_1:action_result.data.*.country_name"
]
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.format(container=container, template=template, parameters=parameters, name="format_ip_and_country_list")
prompt_2(container=container)
return
def list_merge_4(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("list_merge_4() called")
container_artifact_data = phantom.collect2(container=container, datapath=["artifact:*.cef.destinationAddress","artifact:*.cef.sourceAddress","artifact:*.cef.deviceAddress","artifact:*.id"])
container_artifact_cef_item_0 = [item[0] for item in container_artifact_data]
container_artifact_cef_item_1 = [item[1] for item in container_artifact_data]
container_artifact_cef_item_2 = [item[2] for item in container_artifact_data]
parameters = []
parameters.append({
"input_1": container_artifact_cef_item_0,
"input_2": container_artifact_cef_item_1,
"input_3": container_artifact_cef_item_2,
"input_4": None,
"input_5": None,
"input_6": None,
"input_7": None,
"input_8": None,
"input_9": None,
"input_10": None,
})
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.custom_function(custom_function="community/list_merge", parameters=parameters, name="list_merge_4", callback=geolocate_ip_1)
return
def playbook_jan_24_child_demo_1(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("playbook_jan_24_child_demo_1() called")
filtered_result_0_data_filter_out_none = phantom.collect2(container=container, datapath=["filtered-data:filter_out_none:condition_1:geolocate_ip_1:action_result.parameter.ip","filtered-data:filter_out_none:condition_1:geolocate_ip_1:action_result.data.*.country_name"])
prompt_2_result_data = phantom.collect2(container=container, datapath=["prompt_2:action_result.summary.responses.1"], action_results=results)
filtered_result_0_parameter_ip = [item[0] for item in filtered_result_0_data_filter_out_none]
filtered_result_0_data___country_name = [item[1] for item in filtered_result_0_data_filter_out_none]
prompt_2_summary_responses_1 = [item[0] for item in prompt_2_result_data]
inputs = {
"ip": filtered_result_0_parameter_ip,
"countries": filtered_result_0_data___country_name,
"emailaddress": prompt_2_summary_responses_1,
}
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
# call playbook "chris/jan 24 child demo", returns the playbook_run_id
playbook_run_id = phantom.playbook("chris/jan 24 child demo", container=container, name="playbook_jan_24_child_demo_1", callback=format_comment, inputs=inputs)
return
def format_comment(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("format_comment() called")
template = """risk score is {0}\n"""
# parameter list for template variable replacement
parameters = [
"playbook_jan_24_child_demo_1:playbook_output:riskscore"
]
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.format(container=container, template=template, parameters=parameters, name="format_comment")
add_comment_7(container=container)
return
def add_comment_7(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("add_comment_7() called")
format_comment = phantom.get_format_data(name="format_comment")
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.comment(container=container, comment=format_comment)
return
def decision_1(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("decision_1() called")
return
def country_filter(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("country_filter() called")
# collect filtered artifact ids and results for 'if' condition 1
matched_artifacts_1, matched_results_1 = phantom.condition(
container=container,
conditions=[
["filtered-data:filter_out_none:condition_1:geolocate_ip_1:action_result.data.*.country_name", "in", "custom_list:some list"]
],
name="country_filter:condition_1")
# call connected blocks if filtered artifacts or results
if matched_artifacts_1 or matched_results_1:
pin_2(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,
conditions=[
["filtered-data:filter_out_none:condition_1:geolocate_ip_1:action_result.data.*.country_name", "not in", "custom_list:some list"]
],
name="country_filter:condition_2")
# call connected blocks if filtered artifacts or results
if matched_artifacts_2 or matched_results_2:
pin_3(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=matched_artifacts_2, filtered_results=matched_results_2)
return
def pin_2(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("pin_2() called")
filtered_result_0_data_country_filter = phantom.collect2(container=container, datapath=["filtered-data:country_filter:condition_1:geolocate_ip_1:action_result.data.*.country_name","filtered-data:country_filter:condition_1:geolocate_ip_1:action_result.parameter.ip"])
filtered_result_0_data___country_name = [item[0] for item in filtered_result_0_data_country_filter]
filtered_result_0_parameter_ip = [item[1] for item in filtered_result_0_data_country_filter]
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.pin(container=container, data=filtered_result_0_data___country_name, message=filtered_result_0_parameter_ip, pin_style="blue", pin_type="card")
return
def pin_3(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("pin_3() called")
filtered_result_0_data_country_filter = phantom.collect2(container=container, datapath=["filtered-data:country_filter:condition_2:geolocate_ip_1:action_result.data.*.country_name","filtered-data:country_filter:condition_2:geolocate_ip_1:action_result.parameter.ip"])
filtered_result_0_data___country_name = [item[0] for item in filtered_result_0_data_country_filter]
filtered_result_0_parameter_ip = [item[1] for item in filtered_result_0_data_country_filter]
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.pin(container=container, data=filtered_result_0_data___country_name, message=filtered_result_0_parameter_ip, pin_style="red", pin_type="card")
return
def pin_5(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("pin_5() called")
filtered_result_0_data_filter_out_none = phantom.collect2(container=container, datapath=["filtered-data:filter_out_none:condition_2:geolocate_ip_1:action_result.parameter.ip"])
filtered_result_0_parameter_ip = [item[0] for item in filtered_result_0_data_filter_out_none]
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.pin(container=container, data=filtered_result_0_parameter_ip, message="Internal IP", pin_style="grey", pin_type="card")
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