Contribute new pack for Cisco ISE

Transferred from: StackStorm-Exchange/exchange-incubator#166

Author: ip-sf

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+# 0.1.0
+
+- First Version

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

README.md

@@ -0,0 +1,106 @@
+# Integration Pack for Cisco ISE
+
+## cisco_ise
+
+This pack uses [requests](https://requests.readthedocs.io/en/master/) to send and receive data from the ISE API
+
+# Quick-Start
+
+1. Install the pack: `st2 pack install cisco_ise`
+2. Ensure ISE and [ERS is set up](https://developer.cisco.com/docs/identity-services-engine/#!setting-up) for API usage
+3. Run the action `internal_user.get_all` and confirm you received a list of 'Internal Users'
+
+# Configuration
+
+To create and install the configuration file, run:
+
+`st2 pack config cisco_ise`
+
+Alternatively, you can copy the example configuration in
+[cisco_ise.yaml.example](./cisco_ise.yaml.example)
+to `/opt/stackstorm/configs/cisco_ise.yaml` and edit as required.
+
+`connections` is a parent key containing a dictionary of connections that can be referenced by name to use as the connection parameters for action. (Big thanks to the team at Encore Technologies for being my reference material on this aspect of the pack)
+
+Each connection should be a dictionary with one or more of the following keys.
+
+##### Example:
+
+```yaml
+---
+connections:
+  ise_prod:
+    hostname: <host.domain.com>
+    api_user: <value>
+    api_pass: <value>
+```
+
+You can then reference the name of the key in the `connection_name` parameter of the action to load that connection.
+
+Alternatively, you can pass any of the relevant fields directly to the action at run time.
+
+When conflicting values are provided (specifying `connection_name` as well as a `hostname` in the action), the pack will resolve the conflict by using Action values to override the values imported from the config by `connection_name` (Pack determined logic)
+
+For example, if you supply a User/Pass in the configuration, reference it in the action, and a hostname in the action fields directly, you will connect to the host supplied directly to the Action at run time, using the credentials from the pack config.
+
+This behavior is the same for any connection related parameter such as verify_ssl and use_http.
+
+The `hostname` field should contain only an FQDN. Do not include protocol (`https://`), Ports (`:8090`), or paths (`/ers/config`). This info is added to the hostname in [base.py](/actions/lib/base.py).
+
+##### Recommendations
+
+You can also use dynamic values from the datastore for sensitive information. See the [docs](https://docs.stackstorm.com/reference/pack_configs.html) for more info.
+
+An example of this is provided in [the example config](./cisco_ise.yaml.example).
+You can set this value with `st2 key set '<key name>' '<value>' --encrypt` and reference in your config with `"{{ st2kv.system.<key name> | decrypt_kv }}"`
+
+**Note** : When modifying the configuration in `/opt/stackstorm/configs/` please remember to tell StackStorm to load these new values by running `st2ctl reload --register-configs`
+
+# Pack Design
+
+## Action Naming
+
+`uri_resource_name.operation`
+
+Actions are named somewhat consistently with how they are presented in the official documentation. This is in an attempt to create a clear correlation between official documentation and pack actions. Some slight modifications were made to reduce action name length.
+
+##### Example:
+
+In the ISE documentation, there is a resource for [`internaluser`](https://developer.cisco.com/docs/identity-services-engine/#!internal-user) and operation of [Get-By-Id](https://developer.cisco.com/docs/identity-services-engine/#!internal-user/get-by-id). By sending an HTTP `GET` to `/ers/config/internaluser/{id}` you can retrieve a user by id.
+
+The corresponding action in this pack is named [`internal_user.get_by_id`](./actions/internaluser.get_by_id.yaml)
+
+## Code Structure
+
+Why was the [ISE python package](https://pypi.org/project/ISE/) not used?
+
+There is a PIP Package for ISE that was originally developed by [bobthebutcher](https://github.com/bobthebutcher) and [mpenning](https://github.com/mpenning) for ISE `2.0`.
+This package was updated by [falkowich](https://github.com/falkowich) and [karrots](https://github.com/karrots) for ISE `2.4` and notes that testing for `2.7.0` has been completed.
+
+The history of this pack is a great example of the power of OSS, and there is no question about the capability or quality of this package. The reason it was not selected was:
+
+ISE leverages native HTTP Methods and a (somewhat) consistent URI structure.
+
+Writing a simple API client allows for actions to be defined in YAML only, without the need for special usage on a per action basis. Using the Python ISE Package requires new features and capabilities to be added to the python package and the creation of new python actions for this pack. Adding new features via YAML actions is quicker and easier. Alternatively, as a stop-gap, the [request.raw](./actions/request.raw) action allows transparent use of the action logic if there is not a change to the pack. That supports the use of new features before a pack update.
+
+* [base.py](./actions/lib/base.py) - Contains all the shared logic used by every python action
+  * Contains multiple methods intended for use in different ways. Any method not intended to be used directly is prefixed with a single underscore so it isn't imported with `from lib.base import BaseAction`
+* [action.py](./actions/action.py) - The default action that calls the necessary class methods to execute an action.
+  * Uses the methods `action_setup()` and `api_client()` to prepare and parse data and handle the resulting response from the `api_request()` method. (Paging for example)
+* [raw_action.py](./actions/raw_action.py) - An action that only leverages the `retieve_config_connection()`, `api_request()`, and `format_action_result()` methods.
+  * This action allows for some future-proofing as well as showing alternative ways to use the methods of this pack in a case where customized action logic is required.
+
+# References
+
+##### Cisco ISE
+
+* [Official ISE Documentation](https://www.cisco.com/c/en/us/support/security/identity-services-engine/series.html)
+* [Official ISE API Documentation](https://developer.cisco.com/docs/identity-services-engine/#!cisco-ise-api-documentation)
+
+##### Requests for Python
+* [Requests](https://requests.readthedocs.io/en/master/)
+
+# Future
+
+* Unit Testing
+* Logic to understand unique payload structure for each action, allowing field-based inputs rather than JSON Object input for payload.

actions/action.py

@@ -0,0 +1,42 @@
+from lib.base import BaseAction
+
+
+class Action(BaseAction):
+
+    def run(self, **kwargs):
+        """ Run action
+        """
+
+        # Check if action uses 'name' field instead of 'resource_id'
+        # If it does, rebuild resource_id. Used to reduce input parameter confusion
+        # Should come before other modifications incase there is no resource_id.
+        name = kwargs.pop('name', None)
+        if name:
+            self.logger.debug('resource_id being populated from name parameter')
+            kwargs['resource_id'] = f'/name/{name}'
+
+        # Some API Endpoints have a trailing string after the ID.
+        # If a parameter for this string is present, update the resource_id field.
+        url_tail = kwargs.get('url_tail', None)
+        if url_tail:
+            self.logger.debug('adding /{url_tail} to resource_id')
+            kwargs['resource_id'] = f"{kwargs['resource_id']}/{url_tail}"
+
+        # Some API Endpoints have to specify a portal ID after the resource ID.
+        # If a parameter for portal_id, update the resource_id field.
+        portal_id = kwargs.get('portal_id', None)
+        if portal_id:
+            self.logger.debug('adding /portalId/{portal_id} to resource_id')
+            kwargs['resource_id'] = f"{kwargs['resource_id']}/portalId/{portal_id}"
+
+        # Call multiple methods that parse and prepare data
+        # and creates objects that can be used to call api_request()
+        self.action_setup(**kwargs)
+
+        return self.api_client(
+            http_method=self.http_method,
+            request_uri=self.request_uri,
+            api_user=self.connection['api_user'],
+            api_pass=self.connection['api_pass'],
+            verify_ssl=self.connection['verify_ssl'],
+            payload=self.payload)