-
Notifications
You must be signed in to change notification settings - Fork 200
/
G_Suite_for_Gmail_Message_Eviction.py
179 lines (127 loc) · 8.03 KB
/
G_Suite_for_Gmail_Message_Eviction.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
"""
Accepts a gmail email ID and a mailbox, and then attempts to delete the email from the mailbox. \n\nCaution: Emails deleted by running this playbook are deleted permanently and cannot be recovered\n\nRef: D3-ER: https://d3fend.mitre.org/technique/d3f:EmailRemoval/
"""
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 'input_filter' block
input_filter(container=container)
return
@phantom.playbook_block()
def input_filter(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, loop_state_json=None, **kwargs):
phantom.debug("input_filter() called")
################################################################################
# Filter message_id and email 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,
logical_operator="and",
conditions=[
["playbook_input:message_id", "!=", ""],
["playbook_input:email", "!=", ""]
],
name="input_filter:condition_1",
delimiter=None)
# call connected blocks if filtered artifacts or results
if matched_artifacts_1 or matched_results_1:
purge_email(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 purge_email(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, loop_state_json=None, **kwargs):
phantom.debug("purge_email() called")
# phantom.debug('Action: {0} {1}'.format(action['name'], ('SUCCEEDED' if success else 'FAILED')))
################################################################################
# Remove provided gmail email ID in provided mailbox.
################################################################################
filtered_input_0_message_id = phantom.collect2(container=container, datapath=["filtered-data:input_filter:condition_1:playbook_input:message_id"])
filtered_input_1_email = phantom.collect2(container=container, datapath=["filtered-data:input_filter:condition_1:playbook_input:email"])
parameters = []
# build parameters list for 'purge_email' call
for filtered_input_0_message_id_item in filtered_input_0_message_id:
for filtered_input_1_email_item in filtered_input_1_email:
if filtered_input_0_message_id_item[0] is not None and filtered_input_1_email_item[0] is not None:
parameters.append({
"id": filtered_input_0_message_id_item[0],
"email": filtered_input_1_email_item[0],
})
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.act("delete email", parameters=parameters, name="purge_email", assets=["g_suite_for_gmail"], callback=post_delete_filter)
return
@phantom.playbook_block()
def post_delete_filter(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, loop_state_json=None, **kwargs):
phantom.debug("post_delete_filter() called")
################################################################################
# Ensure that the email deletion occurred successfully.
################################################################################
# collect filtered artifact ids and results for 'if' condition 1
matched_artifacts_1, matched_results_1 = phantom.condition(
container=container,
conditions=[
["purge_email:action_result.status", "==", "success"]
],
name="post_delete_filter:condition_1",
delimiter=None)
# call connected blocks if filtered artifacts or results
if matched_artifacts_1 or matched_results_1:
observable_output(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 observable_output(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None, custom_function=None, loop_state_json=None, **kwargs):
phantom.debug("observable_output() called")
################################################################################
# Format a normalized output for each deleted message.
################################################################################
filtered_result_0_data_post_delete_filter = phantom.collect2(container=container, datapath=["filtered-data:post_delete_filter:condition_1:purge_email:action_result.parameter.email","filtered-data:post_delete_filter:condition_1:purge_email:action_result.parameter.id","filtered-data:post_delete_filter:condition_1:purge_email:action_result.status","filtered-data:post_delete_filter:condition_1:purge_email:action_result.message"])
filtered_result_0_parameter_email = [item[0] for item in filtered_result_0_data_post_delete_filter]
filtered_result_0_parameter_id = [item[1] for item in filtered_result_0_data_post_delete_filter]
filtered_result_0_status = [item[2] for item in filtered_result_0_data_post_delete_filter]
filtered_result_0_message = [item[3] for item in filtered_result_0_data_post_delete_filter]
observable_output__observable_array = None
################################################################################
## Custom Code Start
################################################################################
observable_output__observable_array = []
emails = filtered_result_0_parameter_email
messageID = filtered_result_0_parameter_id
Statuses = filtered_result_0_status
Messages = filtered_result_0_message
for email, message_id, status, message in zip(emails, messageID, Statuses, Messages):
observable = {
"mailbox": email,
"message_id": message_id,
"status": "deleted",
"message": message,
"source": "GSuite for GMail"
}
observable_output__observable_array.append(observable)
################################################################################
## Custom Code End
################################################################################
phantom.save_run_data(key="observable_output:observable_array", value=json.dumps(observable_output__observable_array))
return
@phantom.playbook_block()
def on_finish(container, summary):
phantom.debug("on_finish() called")
observable_output__observable_array = json.loads(_ if (_ := phantom.get_run_data(key="observable_output:observable_array")) != "" else "null") # pylint: disable=used-before-assignment
output = {
"observable": observable_output__observable_array,
}
################################################################################
## Custom Code Start
################################################################################
# Write your custom code here...
################################################################################
## Custom Code End
################################################################################
phantom.save_playbook_output_data(output=output)
return