forked from splunk-soar-connectors/abuseipdb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
abuseipdb_connector.py
345 lines (249 loc) · 12.7 KB
/
abuseipdb_connector.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
# File: abuseipdb_connector.py
#
# Copyright (c) 2017-2022 Splunk Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under
# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
# either express or implied. See the License for the specific language governing permissions
# and limitations under the License.
#
#
# Phantom App imports
import json
import phantom.app as phantom
import requests
from bs4 import BeautifulSoup
from phantom.action_result import ActionResult
from phantom.base_connector import BaseConnector
class RetVal(tuple):
def __new__(cls, val1, val2):
return tuple.__new__(RetVal, (val1, val2))
class AbuseipdbConnector(BaseConnector):
def __init__(self):
# Call the BaseConnectors init first
super(AbuseipdbConnector, self).__init__()
def _process_empty_response(self, response, action_result):
if response.status_code == 200:
return RetVal(phantom.APP_SUCCESS, {})
return RetVal(action_result.set_status(phantom.APP_ERROR, "Empty response and no information in the header"), None)
def _process_html_response(self, response, action_result):
# An html response, treat it like an error
status_code = response.status_code
try:
soup = BeautifulSoup(response.text, "html.parser")
error_text = soup.text
split_lines = error_text.split('\n')
split_lines = [x.strip() for x in split_lines if x.strip()]
error_text = '\n'.join(split_lines)
except Exception:
error_text = "Cannot parse error details"
message = "Status Code: {0}. Data from server:\n{1}\n".format(status_code,
error_text)
message = message.replace('{', '{{').replace('}', '}}')
return RetVal(action_result.set_status(phantom.APP_ERROR, message), None)
def _process_json_response(self, response, action_result):
# Try a json parse
try:
resp_json = response.json()
except Exception as e:
return RetVal(action_result.set_status(phantom.APP_ERROR, "Unable to parse JSON response. Error: {0}".format(str(e))), None)
# Please specify the status codes here
if 200 <= response.status_code < 399:
return RetVal(phantom.APP_SUCCESS, resp_json)
# You should process the error returned in the json
message = "Error from server. Status Code: {0} Data from server: {1}".format(
response.status_code, response.text.replace('{', '{{').replace('}', '}}'))
return RetVal(action_result.set_status(phantom.APP_ERROR, message), None)
def _process_response(self, response, action_result):
# store the r_text in debug data, it will get dumped in the logs if the action fails
if hasattr(action_result, 'add_debug_data'):
action_result.add_debug_data({'r_status_code': response.status_code})
action_result.add_debug_data({'r_text': response.text})
action_result.add_debug_data({'r_headers': response.headers})
# Process each 'Content-Type' of response separately
# Process a json response
if 'json' in response.headers.get('Content-Type', ''):
return self._process_json_response(response, action_result)
# Process an HTML response, Do this no matter what the api talks.
# There is a high chance of a PROXY in between phantom and the rest of
# world, in case of errors, PROXY's return HTML, this function parses
# the error and adds it to the action_result.
if 'html' in response.headers.get('Content-Type', ''):
return self._process_html_response(response, action_result)
# it's not content-type that is to be parsed, handle an empty response
if not response.text:
return self._process_empty_response(response, action_result)
# everything else is actually an error at this point
message = "Can't process response from server. Status Code: {0} Data from server: {1}".format(
response.status_code, response.text.replace('{', '{{').replace('}', '}}'))
return RetVal(action_result.set_status(phantom.APP_ERROR, message), None)
def _make_rest_call(self, endpoint, action_result, headers=None, params=None, json_data=None, method="post"):
# Build headers for v2 API Requests
if not headers:
headers = dict()
headers['key'] = self._api_key
headers['accept'] = "application/json"
resp_json = None
try:
request_func = getattr(requests, method)
except AttributeError:
return RetVal(action_result.set_status(phantom.APP_ERROR, "Invalid method: {0}".format(method)), resp_json)
# Create a URL to connect to
url = "{}{}".format(self._base_url, endpoint)
try:
r = request_func(
url,
json=json_data,
headers=headers,
params=params)
except Exception as e:
return RetVal(action_result.set_status(phantom.APP_ERROR, "Error Connecting to server. Details: {0}".format(str(e))), resp_json)
# To validate the API key during a test connectivity action, it is necessary to check for
# HTTP code 429 since we need to Report (post_ip) 127.0.0.1 causing said error if test connectivity was run
# within an interval of 15 min of testing again
if self.get_action_identifier() == 'test_connectivity' and r.status_code == 429:
return RetVal(action_result.set_status(phantom.APP_SUCCESS, ''), None)
return self._process_response(r, action_result)
def _handle_test_connectivity(self, param):
# Add an action result object to self (BaseConnector) to represent the action for this param
action_result = self.add_action_result(ActionResult(dict(param)))
self.save_progress("Connecting to AbuseIPDB")
# build body data for POST request
ip = "127.0.0.1"
categories = "4"
comment = "Test Connectivity"
data = {"ip": ip, "categories": categories, "comment": comment}
# make rest call
ret_val, response = self._make_rest_call('/report', action_result, json_data=data, params=None, headers=None)
if phantom.is_fail(ret_val):
# the call to the 3rd party device or service failed, action result should contain all the error details
# so just return from here
return action_result.get_status()
# Return success
self.save_progress("Test Connectivity Passed")
return action_result.set_status(phantom.APP_SUCCESS)
def _handle_lookup_ip(self, param):
self.save_progress("In action handler for: {0}".format(self.get_action_identifier()))
# Add an action result object to self (BaseConnector) to represent the action for this param
action_result = self.add_action_result(ActionResult(dict(param)))
ip = param['ip']
max_age_in_days = param['days']
verbose = 'yes'
params = {"ipAddress": ip, "maxAgeInDays": max_age_in_days, "verbose": verbose}
# make rest call
# The response is a list of all the reports that we got back from checking the IP
ret_val, reports = self._make_rest_call('/check', action_result, json_data=None, params=params, headers=None, method="get")
if (phantom.is_fail(ret_val)):
return action_result.get_status()
# Add the reports into the data section
action_result.add_data(reports)
reports_list = []
if reports:
data = reports.get('data')
if data:
reports_list = data.get('reports')
summary = action_result.update_summary({})
summary['reports_found'] = len(reports_list)
message = "IP lookup complete. Reports found: {}".format(
summary['reports_found'])
return action_result.set_status(phantom.APP_SUCCESS, message)
def _handle_report_ip(self, param):
self.save_progress("In action handler for: {0}".format(self.get_action_identifier()))
# Add an action result object to self (BaseConnector) to represent the action for this param
action_result = self.add_action_result(ActionResult(dict(param)))
ip = param['ip']
categories = param['category_ids']
categories = ','.join(list(filter(None, categories.split(','))))
comment = param.get('comment', '')
data = {"ip": ip, "categories": categories, "comment": comment}
# make rest call
ret_val, response = self._make_rest_call('/report', action_result, json_data=data, params=None, headers=None)
if (phantom.is_fail(ret_val)):
return action_result.get_status()
# Add the response into the data section
action_result.add_data(response)
summary = action_result.update_summary({})
list_categories = categories.strip().replace(' ', '').split(',')
summary['categories_filed'] = len(list_categories)
summary['comment_length'] = len(comment)
message = "IP reported. Number of categories filed: {}, Comment length: {}".format(
summary['categories_filed'],
summary['comment_length'])
return action_result.set_status(phantom.APP_SUCCESS, message)
def handle_action(self, param):
self.debug_print("action_id", self.get_action_identifier())
# Dictionary mapping each action with its corresponding actions
action_mapping = {
'test_connectivity': self._handle_test_connectivity,
'lookup_ip': self._handle_lookup_ip,
'report_ip': self._handle_report_ip
}
action = self.get_action_identifier()
action_execution_status = phantom.APP_SUCCESS
if action in list(action_mapping.keys()):
action_function = action_mapping[action]
action_execution_status = action_function(param)
return action_execution_status
def initialize(self):
# Load the state in initialize, use it to store data
# that needs to be accessed across actions
self._state = self.load_state()
# API v2
self._base_url = "https://api.abuseipdb.com/api/v2"
# get the asset config
config = self.get_config()
self._api_key = config['api_key']
return phantom.APP_SUCCESS
def finalize(self):
# Save the state, this data is saved across actions and app upgrades
self.save_state(self._state)
return phantom.APP_SUCCESS
if __name__ == '__main__':
import argparse
import pudb
pudb.set_trace()
argparser = argparse.ArgumentParser()
argparser.add_argument('input_test_json', help='Input Test JSON file')
argparser.add_argument('-u', '--username', help='username', required=False)
argparser.add_argument('-p', '--password', help='password', required=False)
args = argparser.parse_args()
session_id = None
username = args.username
password = args.password
if (username is not None and password is None):
# User specified a username but not a password, so ask
import getpass
password = getpass.getpass("Password: ")
if (username and password):
try:
print("Accessing the Login page")
r = requests.get(BaseConnector._get_phantom_base_url() + "login", verify=False)
csrftoken = r.cookies['csrftoken']
data = dict()
data['username'] = username
data['password'] = password
data['csrfmiddlewaretoken'] = csrftoken
headers = dict()
headers['Cookie'] = 'csrftoken=' + csrftoken
headers['Referer'] = BaseConnector._get_phantom_base_url() + "login"
print("Logging into Platform to get the session id")
r2 = requests.post(BaseConnector._get_phantom_base_url() + "login", verify=False, data=data, headers=headers)
session_id = r2.cookies['sessionid']
except Exception as e:
print("Unable to get session id from the platform. Error: " + str(e))
exit(1)
with open(args.input_test_json) as f:
in_json = f.read()
in_json = json.loads(in_json)
print(json.dumps(in_json, indent=4))
connector = AbuseipdbConnector()
connector.print_progress_message = True
ret_val = connector._handle_action(json.dumps(in_json), None)
print(json.dumps(json.loads(ret_val), indent=4))
exit(0)