summaryrefslogtreecommitdiffstats
path: root/ansible_collections/splunk/es/plugins/httpapi/splunk.py
diff options
context:
space:
mode:
Diffstat (limited to 'ansible_collections/splunk/es/plugins/httpapi/splunk.py')
-rw-r--r--ansible_collections/splunk/es/plugins/httpapi/splunk.py77
1 files changed, 77 insertions, 0 deletions
diff --git a/ansible_collections/splunk/es/plugins/httpapi/splunk.py b/ansible_collections/splunk/es/plugins/httpapi/splunk.py
new file mode 100644
index 000000000..91f079e06
--- /dev/null
+++ b/ansible_collections/splunk/es/plugins/httpapi/splunk.py
@@ -0,0 +1,77 @@
+# (c) 2019 Red Hat Inc.
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+DOCUMENTATION = """
+---
+author: Ansible Security Team (@ansible-security)
+name: splunk
+short_description: HttpApi Plugin for Splunk
+description:
+ - This HttpApi plugin provides methods to connect to Splunk over a
+ HTTP(S)-based api.
+version_added: "1.0.0"
+"""
+
+import json
+
+from ansible.module_utils.basic import to_text
+from ansible.errors import AnsibleConnectionFailure
+from ansible.module_utils.six.moves.urllib.error import HTTPError
+from ansible_collections.ansible.netcommon.plugins.plugin_utils.httpapi_base import (
+ HttpApiBase,
+)
+from ansible.module_utils.connection import ConnectionError
+
+BASE_HEADERS = {"Content-Type": "application/json"}
+
+
+class HttpApi(HttpApiBase):
+ def send_request(self, request_method, path, payload=None):
+ # payload = json.dumps(payload) if payload else '{}'
+
+ try:
+ self._display_request(request_method, path)
+ response, response_data = self.connection.send(
+ path,
+ payload,
+ method=request_method,
+ headers=BASE_HEADERS,
+ force_basic_auth=True,
+ )
+ value = self._get_response_value(response_data)
+
+ return response.getcode(), self._response_to_json(value)
+ except AnsibleConnectionFailure as e:
+ self.connection.queue_message(
+ "vvv", "AnsibleConnectionFailure: %s" % e
+ )
+ if to_text("Could not connect to") in to_text(e):
+ raise
+ if to_text("401") in to_text(e):
+ return 401, "Authentication failure"
+ else:
+ return 404, "Object not found"
+ except HTTPError as e:
+ error = json.loads(e.read())
+ return e.code, error
+
+ def _display_request(self, request_method, path):
+ self.connection.queue_message(
+ "vvvv",
+ "Web Services: %s %s/%s"
+ % (request_method, self.connection._url, path),
+ )
+
+ def _get_response_value(self, response_data):
+ return to_text(response_data.getvalue())
+
+ def _response_to_json(self, response_text):
+ try:
+ return json.loads(response_text) if response_text else {}
+ # JSONDecodeError only available on Python 3.5+
+ except ValueError:
+ raise ConnectionError("Invalid JSON response: %s" % response_text)