forked from phantomcyber/playbooks
-
Notifications
You must be signed in to change notification settings - Fork 0
/
AD_LDAP_Account_Unlocking.py
172 lines (122 loc) · 8.11 KB
/
AD_LDAP_Account_Unlocking.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
"""
Accepts user name that needs to be unlocked in Microsoft LDAP Active Directory. Generates an 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 'username_filter' block
username_filter(container=container)
return
@phantom.playbook_block()
def username_filter(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("username_filter() called")
################################################################################
# Filter user name inputs to route inputs to appropriate actions.
################################################################################
# collect filtered artifact ids and results for 'if' condition 1
matched_artifacts_1, matched_results_1 = phantom.condition(
container=container,
conditions=[
["playbook_input:user", "!=", ""]
],
name="username_filter:condition_1",
delimiter=",")
# call connected blocks if filtered artifacts or results
if matched_artifacts_1 or matched_results_1:
enable_user_account(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 enable_user_account(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("enable_user_account() called")
# phantom.debug('Action: {0} {1}'.format(action['name'], ('SUCCEEDED' if success else 'FAILED')))
################################################################################
# Unlock user account from filtered playbook inputs.
################################################################################
filtered_input_0_user = phantom.collect2(container=container, datapath=["filtered-data:username_filter:condition_1:playbook_input:user"])
parameters = []
# build parameters list for 'enable_user_account' call
for filtered_input_0_user_item in filtered_input_0_user:
if filtered_input_0_user_item[0] is not None:
parameters.append({
"user": filtered_input_0_user_item[0],
"use_samaccountname": True,
})
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.act("enable account", parameters=parameters, name="enable_user_account", assets=["microsoft ad ldap"], callback=filter_unlock_account)
return
@phantom.playbook_block()
def username_observables(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("username_observables() called")
################################################################################
# Format a normalized output for each user.
################################################################################
filtered_result_0_data_filter_unlock_account = phantom.collect2(container=container, datapath=["filtered-data:filter_unlock_account:condition_1:enable_user_account:action_result.parameter.user","filtered-data:filter_unlock_account:condition_1:enable_user_account:action_result.parameter.use_samaccountname","filtered-data:filter_unlock_account:condition_1:enable_user_account:action_result.data.*.user_dn","filtered-data:filter_unlock_account:condition_1:enable_user_account:action_result.status","filtered-data:filter_unlock_account:condition_1:enable_user_account:action_result.message","filtered-data:filter_unlock_account:condition_1:enable_user_account:action_result.data.*.starting_status"])
filtered_result_0_parameter_user = [item[0] for item in filtered_result_0_data_filter_unlock_account]
filtered_result_0_parameter_use_samaccountname = [item[1] for item in filtered_result_0_data_filter_unlock_account]
filtered_result_0_data___user_dn = [item[2] for item in filtered_result_0_data_filter_unlock_account]
filtered_result_0_status = [item[3] for item in filtered_result_0_data_filter_unlock_account]
filtered_result_0_message = [item[4] for item in filtered_result_0_data_filter_unlock_account]
filtered_result_0_data___starting_status = [item[5] for item in filtered_result_0_data_filter_unlock_account]
username_observables__observable_array = None
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
username_observables__observable_array = []
for user, sam_account, user_dn, status, msg, prev_status in zip(filtered_result_0_parameter_user, filtered_result_0_parameter_use_samaccountname, filtered_result_0_data___user_dn, filtered_result_0_status, filtered_result_0_message, filtered_result_0_data___starting_status):
user_acc_status = {
"type": "Microsoft AD LDAP user name",
"value": user,
"message": msg,
"status": status
}
username_observables__observable_array.append(user_acc_status)
#phantom.debug(username_observables__observable_array)
################################################################################
## Custom Code End
################################################################################
phantom.save_run_data(key="username_observables:observable_array", value=json.dumps(username_observables__observable_array))
return
@phantom.playbook_block()
def filter_unlock_account(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, **kwargs):
phantom.debug("filter_unlock_account() called")
################################################################################
# filter check if the user is unlocked successfully.
################################################################################
# collect filtered artifact ids and results for 'if' condition 1
matched_artifacts_1, matched_results_1 = phantom.condition(
container=container,
conditions=[
["enable_user_account:action_result.status", "==", "success"]
],
name="filter_unlock_account:condition_1",
delimiter=",")
# call connected blocks if filtered artifacts or results
if matched_artifacts_1 or matched_results_1:
username_observables(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")
username_observables__observable_array = json.loads(_ if (_ := phantom.get_run_data(key="username_observables:observable_array")) != "" else "null") # pylint: disable=used-before-assignment
output = {
"observable": username_observables__observable_array,
}
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.save_playbook_output_data(output=output)
return