forked from phantomcyber/playbooks
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathcustomer_firewall_request_handle_artifact.py
220 lines (175 loc) · 9.66 KB
/
customer_firewall_request_handle_artifact.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
"""
This playbook works in conjunction with "customer_firewall_request_parse_csv". After the first playbook parses the data into artifacts with the label "customer_request", this playbook takes the appropriate block/unblock actions. Between the combination of blocking or unblocking source or destination IP addresses there are four possible actions that can be taken.
"""
import phantom.rules as phantom
import json
from datetime import datetime, timedelta
def on_start(container):
phantom.debug('on_start() called')
# call 'filter_2' block
filter_2(container=container)
return
"""
Artifacts must have the label "customer_request" to be processed.
"""
def filter_2(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None):
phantom.debug('filter_2() called')
# collect filtered artifact ids for 'if' condition 1
matched_artifacts_1, matched_results_1 = phantom.condition(
container=container,
conditions=[
["artifact:*.label", "==", "customer_request"],
],
name="filter_2:condition_1")
# call connected blocks if filtered artifacts or results
if matched_artifacts_1 or matched_results_1:
filter_1(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=matched_artifacts_1, filtered_results=matched_results_1)
return
"""
Split processing based on "block_ip" vs. "unblock_ip" and "sourceAddress" vs. "destinationAddress".
"""
def filter_1(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None):
phantom.debug('filter_1() called')
# collect filtered artifact ids for 'if' condition 1
matched_artifacts_1, matched_results_1 = phantom.condition(
container=container,
conditions=[
["artifact:*.cef.sourceAddress", "!=", ""],
["filtered-data:filter_2:condition_1:artifact:*.cef.destinationAddress", "==", ""],
["filtered-data:filter_2:condition_1:artifact:*.cef.action", "==", "block_ip"],
],
logical_operator='and',
name="filter_1:condition_1")
# call connected blocks if filtered artifacts or results
if matched_artifacts_1 or matched_results_1:
block_src_ip(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=matched_artifacts_1, filtered_results=matched_results_1)
# collect filtered artifact ids for 'if' condition 2
matched_artifacts_2, matched_results_2 = phantom.condition(
container=container,
conditions=[
["filtered-data:filter_2:condition_1:artifact:*.cef.sourceAddress", "==", ""],
["filtered-data:filter_2:condition_1:artifact:*.cef.destinationAddress", "!=", ""],
["filtered-data:filter_2:condition_1:artifact:*.cef.action", "==", "block_ip"],
],
logical_operator='and',
name="filter_1:condition_2")
# call connected blocks if filtered artifacts or results
if matched_artifacts_2 or matched_results_2:
block_dst_ip(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=matched_artifacts_2, filtered_results=matched_results_2)
# collect filtered artifact ids for 'if' condition 3
matched_artifacts_3, matched_results_3 = phantom.condition(
container=container,
conditions=[
["filtered-data:filter_2:condition_1:artifact:*.cef.sourceAddress", "!=", ""],
["filtered-data:filter_2:condition_1:artifact:*.cef.destinationAddress", "==", ""],
["filtered-data:filter_2:condition_1:artifact:*.cef.action", "==", "unblock_ip"],
],
logical_operator='and',
name="filter_1:condition_3")
# call connected blocks if filtered artifacts or results
if matched_artifacts_3 or matched_results_3:
unblock_src_ip(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=matched_artifacts_3, filtered_results=matched_results_3)
# collect filtered artifact ids for 'if' condition 4
matched_artifacts_4, matched_results_4 = phantom.condition(
container=container,
conditions=[
["filtered-data:filter_2:condition_1:artifact:*.cef.sourceAddress", "==", ""],
["filtered-data:filter_2:condition_1:artifact:*.cef.destinationAddress", "!=", ""],
["filtered-data:filter_2:condition_1:artifact:*.cef.action", "==", "unblock_ip"],
],
logical_operator='and',
name="filter_1:condition_4")
# call connected blocks if filtered artifacts or results
if matched_artifacts_4 or matched_results_4:
unblock_dst_ip(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=matched_artifacts_4, filtered_results=matched_results_4)
return
"""
Unblock traffic by source IP address.
"""
def unblock_src_ip(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None):
phantom.debug('unblock_src_ip() called')
# collect data for 'unblock_src_ip' call
filtered_artifacts_data_1 = phantom.collect2(container=container, datapath=['filtered-data:filter_2:condition_1:artifact:*.cef.sourceAddress', 'filtered-data:filter_2:condition_1:artifact:*.id'])
parameters = []
# build parameters list for 'unblock_src_ip' call
for filtered_artifacts_item_1 in filtered_artifacts_data_1:
parameters.append({
'is_source_address': True,
'ip': filtered_artifacts_item_1[0],
'vsys': "",
# context (artifact id) is added to associate results with the artifact
'context': {'artifact_id': filtered_artifacts_item_1[1]},
})
phantom.act("unblock ip", parameters=parameters, assets=['pan_firewall'], name="unblock_src_ip")
return
"""
Block traffic by destination IP address.
"""
def block_dst_ip(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None):
phantom.debug('block_dst_ip() called')
# collect data for 'block_dst_ip' call
filtered_artifacts_data_1 = phantom.collect2(container=container, datapath=['filtered-data:filter_1:condition_2:artifact:*.cef.destinationAddress', 'filtered-data:filter_1:condition_2:artifact:*.id'])
parameters = []
# build parameters list for 'block_dst_ip' call
for filtered_artifacts_item_1 in filtered_artifacts_data_1:
if filtered_artifacts_item_1[0]:
parameters.append({
'is_source_address': False,
'ip': filtered_artifacts_item_1[0],
'vsys': "",
# context (artifact id) is added to associate results with the artifact
'context': {'artifact_id': filtered_artifacts_item_1[1]},
})
phantom.act("block ip", parameters=parameters, assets=['pan_firewall'], name="block_dst_ip")
return
"""
Unblock traffic by destination IP address.
"""
def unblock_dst_ip(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None):
phantom.debug('unblock_dst_ip() called')
# collect data for 'unblock_dst_ip' call
filtered_artifacts_data_1 = phantom.collect2(container=container, datapath=['filtered-data:filter_2:condition_1:artifact:*.cef.destinationAddress', 'filtered-data:filter_2:condition_1:artifact:*.id'])
parameters = []
# build parameters list for 'unblock_dst_ip' call
for filtered_artifacts_item_1 in filtered_artifacts_data_1:
parameters.append({
'is_source_address': False,
'ip': filtered_artifacts_item_1[0],
'vsys': "",
# context (artifact id) is added to associate results with the artifact
'context': {'artifact_id': filtered_artifacts_item_1[1]},
})
phantom.act("unblock ip", parameters=parameters, assets=['pan_firewall'], name="unblock_dst_ip")
return
"""
Block traffic by source IP address.
"""
def block_src_ip(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None):
phantom.debug('block_src_ip() called')
# collect data for 'block_src_ip' call
filtered_artifacts_data_1 = phantom.collect2(container=container, datapath=['filtered-data:filter_1:condition_1:artifact:*.cef.sourceAddress', 'filtered-data:filter_1:condition_1:artifact:*.id'])
parameters = []
# build parameters list for 'block_src_ip' call
for filtered_artifacts_item_1 in filtered_artifacts_data_1:
if filtered_artifacts_item_1[0]:
parameters.append({
'is_source_address': True,
'ip': filtered_artifacts_item_1[0],
'vsys': "",
# context (artifact id) is added to associate results with the artifact
'context': {'artifact_id': filtered_artifacts_item_1[1]},
})
phantom.act("block ip", parameters=parameters, assets=['pan_firewall'], name="block_src_ip")
return
def on_finish(container, summary):
phantom.debug('on_finish() called')
# This function is called after all actions are completed.
# summary of all the action and/or all detals 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)
return