Adding upstream version 7.3.0+dfsg.upstream/7.3.0+dfsgupstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 471 insertions, 0 deletions

diff --git a/ansible_collections/cisco/intersight/plugins/module_utils/intersight.py b/ansible_collections/cisco/intersight/plugins/module_utils/intersight.py
new file mode 100644
index 00000000..4bfd0e93
--- /dev/null
+++ b/ansible_collections/cisco/intersight/plugins/module_utils/intersight.py
@@ -0,0 +1,471 @@
+# This code is part of Ansible, but is an independent component.
+# This particular file snippet, and this file snippet only, is BSD licensed.
+# Modules you write using this snippet, which is embedded dynamically by Ansible
+# still belong to the author of the module, and may assign their own license
+# to the complete work.
+#
+# (c) 2016 Red Hat Inc.
+# (c) 2020 Cisco Systems Inc.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+#    * Redistributions of source code must retain the above copyright
+#      notice, this list of conditions and the following disclaimer.
+#    * Redistributions in binary form must reproduce the above copyright notice,
+#      this list of conditions and the following disclaimer in the documentation
+#      and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# Intersight REST API Module
+# Author: Matthew Garrett
+# Contributors: David Soper, Chris Gascoigne, John McDonough
+
+from base64 import b64encode
+from email.utils import formatdate
+import re
+import json
+import hashlib
+from ansible.module_utils.six import iteritems
+from ansible.module_utils.six.moves.urllib.parse import urlparse, urlencode
+from ansible.module_utils.urls import fetch_url
+from ansible.module_utils.basic import env_fallback
+
+try:
+    from cryptography.hazmat.primitives import serialization, hashes
+    from cryptography.hazmat.primitives.asymmetric import padding, ec
+    from cryptography.hazmat.backends import default_backend
+    HAS_CRYPTOGRAPHY = True
+except ImportError:
+    HAS_CRYPTOGRAPHY = False
+
+intersight_argument_spec = dict(
+    api_private_key=dict(fallback=(env_fallback, ['INTERSIGHT_API_PRIVATE_KEY']), type='path', required=True, no_log=True),
+    api_uri=dict(fallback=(env_fallback, ['INTERSIGHT_API_URI']), type='str', default='https://intersight.com/api/v1'),
+    api_key_id=dict(fallback=(env_fallback, ['INTERSIGHT_API_KEY_ID']), type='str', required=True),
+    validate_certs=dict(type='bool', default=True),
+    use_proxy=dict(type='bool', default=True),
+)
+
+
+def get_sha256_digest(data):
+    """
+    Generates a SHA256 digest from a String.
+
+    :param data: data string set by user
+    :return: instance of digest object
+    """
+
+    digest = hashlib.sha256()
+    digest.update(data.encode())
+
+    return digest
+
+
+def prepare_str_to_sign(req_tgt, hdrs):
+    """
+    Concatenates Intersight headers in preparation to be signed
+
+    :param req_tgt : http method plus endpoint
+    :param hdrs: dict with header keys
+    :return: concatenated header authorization string
+    """
+    ss = ""
+    ss = ss + "(request-target): " + req_tgt + "\n"
+
+    length = len(hdrs.items())
+
+    i = 0
+    for key, value in hdrs.items():
+        ss = ss + key.lower() + ": " + value
+        if i < length - 1:
+            ss = ss + "\n"
+        i += 1
+
+    return ss
+
+
+def get_gmt_date():
+    """
+    Generated a GMT formatted Date
+
+    :return: current date
+    """
+
+    return formatdate(timeval=None, localtime=False, usegmt=True)
+
+
+def compare_lists(expected_list, actual_list):
+    if len(expected_list) != len(actual_list):
+        # mismatch if list lengths aren't equal
+        return False
+    for expected, actual in zip(expected_list, actual_list):
+        # if compare_values returns False, stop the loop and return
+        if not compare_values(expected, actual):
+            return False
+    # loop complete with all items matching
+    return True
+
+
+def compare_values(expected, actual):
+    try:
+        if isinstance(expected, list) and isinstance(actual, list):
+            return compare_lists(expected, actual)
+        for (key, value) in iteritems(expected):
+            if re.search(r'P(ass)?w(or)?d', key) or key not in actual:
+                # do not compare any password related attributes or attributes that are not in the actual resource
+                continue
+            if not compare_values(value, actual[key]):
+                return False
+        # loop complete with all items matching
+        return True
+    except (AttributeError, TypeError):
+        # if expected and actual != expected:
+        if actual != expected:
+            return False
+        return True
+
+
+class IntersightModule():
+
+    def __init__(self, module):
+        self.module = module
+        self.result = dict(changed=False)
+        if not HAS_CRYPTOGRAPHY:
+            self.module.fail_json(msg='cryptography is required for this module')
+        self.host = self.module.params['api_uri']
+        self.public_key = self.module.params['api_key_id']
+        try:
+            with open(self.module.params['api_private_key'], 'r') as f:
+                self.private_key = f.read()
+        except (FileNotFoundError, OSError):
+            self.private_key = self.module.params['api_private_key']
+        self.digest_algorithm = ''
+        self.response_list = []
+
+    def get_sig_b64encode(self, data):
+        """
+        Generates a signed digest from a String
+
+        :param digest: string to be signed & hashed
+        :return: instance of digest object
+        """
+        # Python SDK code: Verify PEM Pre-Encapsulation Boundary
+        r = re.compile(r"\s*-----BEGIN (.*)-----\s+")
+        m = r.match(self.private_key)
+        if not m:
+            raise ValueError("Not a valid PEM pre boundary")
+        pem_header = m.group(1)
+        key = serialization.load_pem_private_key(self.private_key.encode(), None, default_backend())
+        if pem_header == 'RSA PRIVATE KEY':
+            sign = key.sign(data.encode(), padding.PKCS1v15(), hashes.SHA256())
+            self.digest_algorithm = 'rsa-sha256'
+        elif pem_header == 'EC PRIVATE KEY':
+            sign = key.sign(data.encode(), ec.ECDSA(hashes.SHA256()))
+            self.digest_algorithm = 'hs2019'
+        else:
+            raise Exception("Unsupported key: {0}".format(pem_header))
+
+        return b64encode(sign)
+
+    def get_auth_header(self, hdrs, signed_msg):
+        """
+        Assmebled an Intersight formatted authorization header
+
+        :param hdrs : object with header keys
+        :param signed_msg: base64 encoded sha256 hashed body
+        :return: concatenated authorization header
+        """
+
+        auth_str = "Signature"
+
+        auth_str = auth_str + " " + "keyId=\"" + self.public_key + "\"," + "algorithm=\"" + self.digest_algorithm + "\","
+
+        auth_str = auth_str + "headers=\"(request-target)"
+
+        for key, dummy in hdrs.items():
+            auth_str = auth_str + " " + key.lower()
+        auth_str = auth_str + "\""
+
+        auth_str = auth_str + "," + "signature=\"" + signed_msg.decode('ascii') + "\""
+
+        return auth_str
+
+    def get_moid_by_name(self, resource_path, target_name):
+        """
+        Retrieve an Intersight object moid by name
+
+        :param resource_path: intersight resource path e.g. '/ntp/Policies'
+        :param target_name: intersight object name
+        :return: json http response object
+        """
+        query_params = {
+            "$filter": "Name eq '{0}'".format(target_name)
+        }
+
+        options = {
+            "http_method": "GET",
+            "resource_path": resource_path,
+            "query_params": query_params
+        }
+
+        get_moid = self.intersight_call(**options)
+
+        if get_moid.json()['Results'] is not None:
+            located_moid = get_moid.json()['Results'][0]['Moid']
+        else:
+            raise KeyError('Intersight object with name "{0}" not found!'.format(target_name))
+
+        return located_moid
+
+    def call_api(self, **options):
+        """
+        Call the Intersight API and check for success status
+        :param options: options dict with method and other params for API call
+        :return: json http response object
+        """
+
+        try:
+            response, info = self.intersight_call(**options)
+            if not re.match(r'2..', str(info['status'])):
+                raise RuntimeError(info['status'], info['msg'], info['body'])
+        except Exception as e:
+            self.module.fail_json(msg="API error: %s " % str(e))
+
+        response_data = response.read()
+        if len(response_data) > 0:
+            resp_json = json.loads(response_data)
+            resp_json['trace_id'] = info.get('x-starship-traceid')
+            return resp_json
+        return {}
+
+    def intersight_call(self, http_method="", resource_path="", query_params=None, body=None, moid=None, name=None):
+        """
+        Invoke the Intersight API
+
+        :param resource_path: intersight resource path e.g. '/ntp/Policies'
+        :param query_params: dictionary object with query string parameters as key/value pairs
+        :param body: dictionary object with intersight data
+        :param moid: intersight object moid
+        :param name: intersight object name
+        :return: json http response object
+        """
+
+        target_host = urlparse(self.host).netloc
+        target_path = urlparse(self.host).path
+        query_path = ""
+        method = http_method.upper()
+        bodyString = ""
+
+        # Verify an accepted HTTP verb was chosen
+        if(method not in ['GET', 'POST', 'PATCH', 'DELETE']):
+            raise ValueError('Please select a valid HTTP verb (GET/POST/PATCH/DELETE)')
+
+        # Verify the resource path isn't empy & is a valid <str> object
+        if(resource_path != "" and not (resource_path, str)):
+            raise TypeError('The *resource_path* value is required and must be of type "<str>"')
+
+        # Verify the query parameters isn't empy & is a valid <dict> object
+        if(query_params is not None and not isinstance(query_params, dict)):
+            raise TypeError('The *query_params* value must be of type "<dict>"')
+
+        # Verify the MOID is not null & of proper length
+        if(moid is not None and len(moid.encode('utf-8')) != 24):
+            raise ValueError('Invalid *moid* value!')
+
+        # Check for query_params, encode, and concatenate onto URL
+        if query_params:
+            query_path = "?" + urlencode(query_params)
+
+        # Handle PATCH/DELETE by Object "name" instead of "moid"
+        if method in ('PATCH', 'DELETE'):
+            if moid is None:
+                if name is not None:
+                    if isinstance(name, str):
+                        moid = self.get_moid_by_name(resource_path, name)
+                    else:
+                        raise TypeError('The *name* value must be of type "<str>"')
+                else:
+                    raise ValueError('Must set either *moid* or *name* with "PATCH/DELETE!"')
+
+        # Check for moid and concatenate onto URL
+        if moid is not None:
+            resource_path += "/" + moid
+
+        # Check for GET request to properly form body
+        if method != "GET":
+            bodyString = json.dumps(body)
+
+        # Concatenate URLs for headers
+        target_url = self.host + resource_path + query_path
+        request_target = method.lower() + " " + target_path + resource_path + query_path
+
+        # Get the current GMT Date/Time
+        cdate = get_gmt_date()
+
+        # Generate the body digest
+        body_digest = get_sha256_digest(bodyString)
+        b64_body_digest = b64encode(body_digest.digest())
+
+        # Generate the authorization header
+        auth_header = {
+            'Host': target_host,
+            'Date': cdate,
+            'Digest': "SHA-256=" + b64_body_digest.decode('ascii'),
+        }
+
+        string_to_sign = prepare_str_to_sign(request_target, auth_header)
+        b64_signed_msg = self.get_sig_b64encode(string_to_sign)
+        auth_header = self.get_auth_header(auth_header, b64_signed_msg)
+
+        # Generate the HTTP requests header
+        request_header = {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+            'Host': '{0}'.format(target_host),
+            'Date': '{0}'.format(cdate),
+            'Digest': 'SHA-256={0}'.format(b64_body_digest.decode('ascii')),
+            'Authorization': '{0}'.format(auth_header),
+        }
+
+        response, info = fetch_url(self.module, target_url, data=bodyString, headers=request_header, method=method, use_proxy=self.module.params['use_proxy'])
+
+        return response, info
+
+    def get_resource(self, resource_path, query_params, return_list=False):
+        '''
+        GET a resource and return the 1st element found or the full Results list
+        '''
+        options = {
+            'http_method': 'get',
+            'resource_path': resource_path,
+            'query_params': query_params,
+        }
+        response = self.call_api(**options)
+        if response.get('Results'):
+            if return_list:
+                self.result['api_response'] = response['Results']
+            else:
+                # return the 1st list element
+                self.result['api_response'] = response['Results'][0]
+        self.result['trace_id'] = response.get('trace_id')
+
+    def configure_resource(self, moid, resource_path, body, query_params, update_method=''):
+        if not self.module.check_mode:
+            if moid and update_method != 'post':
+                # update the resource - user has to specify all the props they want updated
+                options = {
+                    'http_method': 'patch',
+                    'resource_path': resource_path,
+                    'body': body,
+                    'moid': moid,
+                }
+                response_dict = self.call_api(**options)
+                if response_dict.get('Results'):
+                    # return the 1st element in the results list
+                    self.result['api_response'] = response_dict['Results'][0]
+                    self.result['trace_id'] = response_dict.get('trace_id')
+            else:
+                # create the resource
+                options = {
+                    'http_method': 'post',
+                    'resource_path': resource_path,
+                    'body': body,
+                }
+                response_dict = self.call_api(**options)
+                if response_dict:
+                    self.result['api_response'] = response_dict
+                    self.result['trace_id'] = response_dict.get('trace_id')
+                elif query_params:
+                    # POSTs may not return any data.
+                    # Get the current state of the resource if query_params.
+                    self.get_resource(
+                        resource_path=resource_path,
+                        query_params=query_params,
+                    )
+        self.result['changed'] = True
+
+    def delete_resource(self, moid, resource_path):
+        # delete resource and create empty api_response
+        if not self.module.check_mode:
+            options = {
+                'http_method': 'delete',
+                'resource_path': resource_path,
+                'moid': moid,
+            }
+            resp = self.call_api(**options)
+            self.result['api_response'] = {}
+            self.result['trace_id'] = resp.get('trace_id')
+        self.result['changed'] = True
+
+    def configure_policy_or_profile(self, resource_path):
+        # Configure (create, update, or delete) the policy or profile
+        organization_moid = None
+        # GET Organization Moid
+        self.get_resource(
+            resource_path='/organization/Organizations',
+            query_params={
+                '$filter': "Name eq '" + self.module.params['organization'] + "'",
+                '$select': 'Moid',
+            },
+        )
+        if self.result['api_response'].get('Moid'):
+            # resource exists and moid was returned
+            organization_moid = self.result['api_response']['Moid']
+
+        self.result['api_response'] = {}
+        # Get the current state of the resource
+        filter_str = "Name eq '" + self.module.params['name'] + "'"
+        filter_str += "and Organization.Moid eq '" + organization_moid + "'"
+        self.get_resource(
+            resource_path=resource_path,
+            query_params={
+                '$filter': filter_str,
+                '$expand': 'Organization',
+            }
+        )
+
+        moid = None
+        resource_values_match = False
+        if self.result['api_response'].get('Moid'):
+            # resource exists and moid was returned
+            moid = self.result['api_response']['Moid']
+            if self.module.params['state'] == 'present':
+                resource_values_match = compare_values(self.api_body, self.result['api_response'])
+            else:  # state == 'absent'
+                self.delete_resource(
+                    moid=moid,
+                    resource_path=resource_path,
+                )
+                moid = None
+
+        if self.module.params['state'] == 'present' and not resource_values_match:
+            # remove read-only Organization key
+            self.api_body.pop('Organization')
+            if not moid:
+                # Organization must be set, but can't be changed after initial POST
+                self.api_body['Organization'] = {
+                    'Moid': organization_moid,
+                }
+            self.configure_resource(
+                moid=moid,
+                resource_path=resource_path,
+                body=self.api_body,
+                query_params={
+                    '$filter': filter_str
+                }
+            )
+            if self.result['api_response'].get('Moid'):
+                # resource exists and moid was returned
+                moid = self.result['api_response']['Moid']
+
+        return moid