-
Notifications
You must be signed in to change notification settings - Fork 194
/
Active_Directory_Enable_Account_Dispatch.py
294 lines (209 loc) · 13.3 KB
/
Active_Directory_Enable_Account_Dispatch.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
"""
Accepts user name that needs to be enabled in Active Directory. Generates a report and observable output based on the status of account unlocking or enabling.
"""
import phantom.rules as phantom
import json
from datetime import datetime, timedelta
@phantom.playbook_block()
def on_start(container):
phantom.debug('on_start() called')
# call 'dispatch_account_enable' block
dispatch_account_enable(container=container)
return
@phantom.playbook_block()
def dispatch_account_enable(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("dispatch_account_enable() called")
playbook_tags_combined_value = phantom.concatenate("enable_account", "active_directory")
inputs = {
"playbook_repo": [],
"playbook_tags": playbook_tags_combined_value,
"artifact_ids_include": [],
"indicator_tags_exclude": [],
"indicator_tags_include": [],
}
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
# call playbook "community/dispatch_input_playbooks", returns the playbook_run_id
playbook_run_id = phantom.playbook("community/dispatch_input_playbooks", container=container, name="dispatch_account_enable", callback=observable_output_decision, inputs=inputs)
return
@phantom.playbook_block()
def observable_output_decision(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("observable_output_decision() called")
################################################################################
# Decision to check if observable output is successfully generated or not.
################################################################################
# check for 'if' condition 1
found_match_1 = phantom.decision(
container=container,
conditions=[
["dispatch_account_enable:playbook_output:observable", "!=", ""]
],
case_sensitive=False,
delimiter=None)
# call connected blocks if condition 1 matched
if found_match_1:
observable_filter(action=action, success=success, container=container, results=results, handle=handle)
return
# check for 'else' condition 2
observable_check_comment(action=action, success=success, container=container, results=results, handle=handle)
return
@phantom.playbook_block()
def normalized_observable_filter(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("normalized_observable_filter() called")
################################################################################
# This block uses custom code for normalizing observable result of input playbooks
# tag as disable_account. The normalized output will be used in merging 4 different
# types of disable_account used to locked users in active directory.
################################################################################
filtered_output_0_dispatch_account_enable_output_observable = phantom.collect2(container=container, datapath=["filtered-data:observable_filter:condition_1:dispatch_account_enable:playbook_output:observable"])
filtered_output_0_dispatch_account_enable_output_observable_values = [item[0] for item in filtered_output_0_dispatch_account_enable_output_observable]
normalized_observable_filter__observable_value = None
normalized_observable_filter__observable_type = None
normalized_observable_filter__observable_merge_report = None
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
normalized_observable_filter__observable_message = []
normalized_observable_filter__observable_value = []
normalized_observable_filter__observable_merge_report = []
fmt_output = ""
output_observable_values = [(i or "") for i in filtered_output_0_dispatch_account_enable_output_observable_values]
phantom.debug("output_observable_values: {}".format(output_observable_values))
for observable_item in output_observable_values:
if observable_item['status'] == "success":
user_name = observable_item['value'].split("@")[0]
normalized_observable_filter__observable_value.append(user_name)
fmt_output += "{} | {} | {} | {} | \n".format(observable_item['value'], observable_item['type'], observable_item['message'], observable_item['status'])
normalized_observable_filter__observable_merge_report.append(fmt_output)
normalized_observable_filter__observable_value = normalized_observable_filter__observable_value[0]
normalized_observable_filter__observable_type = "Enable Account"
phantom.debug(normalized_observable_filter__observable_merge_report)
################################################################################
## Custom Code End
################################################################################
phantom.save_run_data(key="normalized_observable_filter:observable_value", value=json.dumps(normalized_observable_filter__observable_value))
phantom.save_run_data(key="normalized_observable_filter:observable_type", value=json.dumps(normalized_observable_filter__observable_type))
phantom.save_run_data(key="normalized_observable_filter:observable_merge_report", value=json.dumps(normalized_observable_filter__observable_merge_report))
merge_report(container=container)
return
@phantom.playbook_block()
def observable_check_comment(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("observable_check_comment() called")
################################################################################
# observable output of input playbooks not exits.
################################################################################
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.comment(container=container, comment="Observable output of input playbooks does not exist.")
return
@phantom.playbook_block()
def merge_report(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("merge_report() called")
################################################################################
# summary report for all disable account input playbooks.
################################################################################
template = """SOAR attempted to unlock account(s). The table below shows a summary of the information gathered.\\n\\n\n| Value | Type | Message | Status |\n| --- | --- | --- | --- |\n%%\n| {0} \n%%\n"""
# parameter list for template variable replacement
parameters = [
"normalized_observable_filter:custom_function:observable_merge_report"
]
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
#phantom.debug(phantom.format(container=container, template=template, parameters=parameters, name="merge_report"))
################################################################################
## Custom Code End
################################################################################
phantom.format(container=container, template=template, parameters=parameters, name="merge_report")
tag_indicators(container=container)
return
@phantom.playbook_block()
def tag_indicators(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("tag_indicators() called")
################################################################################
# adding indicator tag for each disabled account.
################################################################################
normalized_observable_filter__observable_type = json.loads(_ if (_ := phantom.get_run_data(key="normalized_observable_filter:observable_type")) != "" else "null") # pylint: disable=used-before-assignment
normalized_observable_filter__observable_value = json.loads(_ if (_ := phantom.get_run_data(key="normalized_observable_filter:observable_value")) != "" else "null") # pylint: disable=used-before-assignment
parameters = []
parameters.append({
"tags": normalized_observable_filter__observable_type,
"indicator": normalized_observable_filter__observable_value,
"overwrite": None,
})
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.custom_function(custom_function="community/indicator_tag", parameters=parameters, name="tag_indicators", callback=update_workbook_task)
return
@phantom.playbook_block()
def update_workbook_task(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("update_workbook_task() called")
################################################################################
# update workbook task of this dispatch playbook
################################################################################
id_value = container.get("id", None)
merge_report = phantom.get_format_data(name="merge_report")
parameters = []
parameters.append({
"owner": None,
"status": "complete",
"container": id_value,
"task_name": "playbook",
"note_title": "AD Enable Account Report",
"note_content": merge_report,
})
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.custom_function(custom_function="community/workbook_task_update", parameters=parameters, name="update_workbook_task")
return
@phantom.playbook_block()
def observable_filter(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("observable_filter() called")
################################################################################
# Filter to check if observable output is successfully generated or not.
################################################################################
# collect filtered artifact ids and results for 'if' condition 1
matched_artifacts_1, matched_results_1 = phantom.condition(
container=container,
conditions=[
["dispatch_account_enable:playbook_output:observable", "!=", ""]
],
name="observable_filter:condition_1",
delimiter=None)
# call connected blocks if filtered artifacts or results
if matched_artifacts_1 or matched_results_1:
normalized_observable_filter(action=action, success=success, container=container, results=results, handle=handle, filtered_artifacts=matched_artifacts_1, filtered_results=matched_results_1)
return
@phantom.playbook_block()
def on_finish(container, summary):
phantom.debug("on_finish() called")
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
return