diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml new file mode 100644 index 0000000..131c639 --- /dev/null +++ b/.github/workflows/linting.yml @@ -0,0 +1,11 @@ +name: Linting +on: [push, pull_request] +jobs: + lint: + # Run per push for internal contributers. This isn't possible for forked pull requests, + # so we'll need to run on PR events for external contributers. + # String comparison below is case insensitive. + if: github.event_name == 'push' || github.event.pull_request.head.repo.fork + runs-on: ubuntu-latest + steps: + - uses: 'phantomcyber/dev-cicd-tools/github-actions/lint@main' diff --git a/.github/workflows/semgrep.yml b/.github/workflows/semgrep.yml new file mode 100644 index 0000000..712cc1b --- /dev/null +++ b/.github/workflows/semgrep.yml @@ -0,0 +1,28 @@ +name: Semgrep +on: + pull_request_target: + branches: + - next + - main + push: + branches: + - next + - main +jobs: + semgrep: + runs-on: ubuntu-latest + steps: + - if: github.event_name == 'push' + run: | + echo "REPOSITORY=${{ github.repository }}" >> $GITHUB_ENV + echo "REF=${{ github.REF }}" >> $GITHUB_ENV + - if: github.event_name == 'pull_request_target' + run: | + echo "REPOSITORY=${{ github.event.pull_request.head.repo.full_name }}" >> $GITHUB_ENV + echo "REF=${{ github.event.pull_request.head.ref }}" >> $GITHUB_ENV + - uses: 'phantomcyber/dev-cicd-tools/github-actions/semgrep@main' + with: + SEMGREP_DEPLOYMENT_ID: ${{ secrets.SEMGREP_DEPLOYMENT_ID }} + SEMGREP_APP_TOKEN: ${{ secrets.SEMGREP_APP_TOKEN }} + REPOSITORY: ${{ github.repository }} + REF: ${{ github.ref }} diff --git a/.github/workflows/start-release.yml b/.github/workflows/start-release.yml new file mode 100644 index 0000000..7d47230 --- /dev/null +++ b/.github/workflows/start-release.yml @@ -0,0 +1,9 @@ +name: Start Release +on: workflow_dispatch +jobs: + start-release: + runs-on: ubuntu-latest + steps: + - uses: 'phantomcyber/dev-cicd-tools/github-actions/start-release@main' + with: + GITHUB_TOKEN: ${{ secrets.SOAR_APPS_TOKEN }} diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml deleted file mode 100644 index 38e1594..0000000 --- a/.gitlab-ci.yml +++ /dev/null @@ -1,3 +0,0 @@ -include: - - project: 'phantom/appscript' - file: 'gitlab-ci/.gitlab-ci.yml' diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..46e4d88 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,11 @@ +repos: +- repo: https://github.com/phantomcyber/dev-cicd-tools + rev: v1.8 + hooks: + - id: org-hook + - id: package-app-dependencies +- repo: https://github.com/Yelp/detect-secrets + rev: v1.1.0 + hooks: + - id: detect-secrets + args: ['--no-verify', '--exclude-files', '^f5bigipltm.json$'] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b3cc507 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,2 @@ +# Contributing +For more information about contributing to Splunk SOAR Apps please take a look at our app [Contribution Guide](https://github.com/splunk-soar-connectors/.github/blob/main/.github/CONTRIBUTING.md)! diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f9b71ef --- /dev/null +++ b/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 (c) 2019-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. \ No newline at end of file diff --git a/Makefile b/Makefile deleted file mode 100644 index 7af3212..0000000 --- a/Makefile +++ /dev/null @@ -1,81 +0,0 @@ -# Makefile for Phantom apps CI -# created oct-2018 by michellel & jacobd at splunk -# -# Usage: -# make local - to bring up docker for local dev -# make - pipeline targets build / upload -# make secrets - list any required secret values -# -# Credentials can be passed as environment variables or docker secret files -# under /run/secrets - - -# Variables set by GitLab -WORKSPACE ?= $(shell grep WORKSPACE: docker-compose.yml | cut -d : -f 2) -CI_COMMIT_REF_NAME ?= $(shell git branch | grep "\*" | cut -d ' ' -f 2) - -# Git variables -GIT_SERVER ?= cd.splunkdev.com -RELEASE_GROUP ?= phantom -RELEASE_REPO ?= app_release -RELEASE_DIR := $(WORKSPACE)/$(RELEASE_REPO) - -# Docker variables -export IMAGE_TAG ?= $(shell grep ^image: .gitlab-ci.yml | cut -d : -f 3) - -# Variables sent to app_release for test/build/release scripts -export APP_DIR ?= $(shell pwd) -export APP_REPO_NAME ?= $(shell basename $(APP_DIR)) -export APP_BRANCH ?= $(CI_COMMIT_REF_NAME) -export TEST_BRANCH ?= master - -# Pipeline secrets -SECRETS = app_artf_token gitlab_api_token app_deploy_key -ifneq ($(wildcard /run/secrets/.),) - # Load secrets if specified in filesystem rather than variables - export GITLAB_API_TOKEN ?= $(shell cat /run/secrets/gitlab_api_token) - export APP_ARTF_TOKEN ?= $(shell cat /run/secrets/app_artf_token) - export APP_DEPLOY_KEY ?= $(shell cat /run/secrets/app_deploy_key) -endif - -APP_RELEASE_TARGETS = test upload build release -.PHONY: checkout local secrets list_secrets $(APP_RELEASE_TARGETS) - -checkout: $(RELEASE_DIR) -$(RELEASE_DIR): /tmp/ssh-agent - $(info Clone the $(RELEASE_REPO) repo into $(RELEASE_DIR)) - @git clone git@$(GIT_SERVER):$(RELEASE_GROUP)/$(RELEASE_REPO).git $(RELEASE_DIR) - $(info Checkout the test branch: $(TEST_BRANCH)) - @cd $(RELEASE_DIR) && git checkout $(TEST_BRANCH) - -$(APP_RELEASE_TARGETS): checkout - @cd $(RELEASE_DIR) && make $@ - -local: secrets - $(info Setting up local development instance) - $(info Make sure you have run:) - $(info docker login repo.splunk.com) - docker-compose up -d - $(info Working directory is mapped to $(DOCKER_WORK). To connect:) - $(info docker exec -it -w $(DOCKER_WORK) local_qa-local_1 bash) - -/tmp/ssh-agent: - $(info Starting ssh agent) - @mkdir -p -m 700 ~/.ssh - @ssh-keyscan -p 22 $(GIT_SERVER) >> ~/.ssh/known_hosts - @eval $(shell ssh-agent -s >$@) - @if [ -s /run/secrets/app_deploy_key ]; then \ - cp /run/secrets/app_deploy_key ~/.ssh/id_rsa && \ - source $@ && ssh-add ~/.ssh/id_rsa; \ - else \ - cp ~/.ssh/app_deploy_key ~/.ssh/id_rsa && \ - chmod 600 ~/.ssh/id_rsa && \ - cat $@ && \ - source $@ && ssh-add ~/.ssh/id_rsa; \ - fi - -SECRET_FILES = $(foreach I,$(SECRETS),~/.docker/secrets/$I) -secrets: list_secrets $(SECRET_FILES) -list_secrets: - $(info From .docker/secrets these files are loaded:) - $(info $(SECRETS)) diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..db2ca2b --- /dev/null +++ b/NOTICE @@ -0,0 +1,16 @@ +Splunk SOAR F5 BIG-IP LTM +Copyright (c) 2019-2022 Splunk Inc. + +Third-party Software Attributions: + +Library: beautifulsoup4 +Version: 4.9.1 +License: MIT +Copyright 2004-2017 Leonard Richardson +Copyright 2004-2019 Leonard Richardson +Copyright 2018 Isaac Muse + +Library: requests +Version: 2.25.0 +License: Apache 2.0 +Kenneth Reitz diff --git a/README.md b/README.md new file mode 100644 index 0000000..d63e31a --- /dev/null +++ b/README.md @@ -0,0 +1,581 @@ +[comment]: # "Auto-generated SOAR connector documentation" +# F5 BIG\-IP LTM + +Publisher: Splunk +Connector Version: 2\.0\.8 +Product Vendor: F5 +Product Name: Local Traffic Manager +Product Version Supported (regex): "\.\*" +Minimum Product Version: 4\.6\.19142 + +This app implements investigate and generic actions to integrate with an F5 BIG\-IP LTM instance to manage pools and nodes + +### Configuration Variables +The below configuration variables are required for this Connector to operate. These variables are specified when configuring a Local Traffic Manager asset in SOAR. + +VARIABLE | REQUIRED | TYPE | DESCRIPTION +-------- | -------- | ---- | ----------- +**base\_url** | required | string | Base URL of F5 BIG\-IP LTM instance \(e\.g\. https\://10\.1\.16\.110\) +**username** | required | string | User name +**password** | required | password | Password +**verify\_server\_cert** | optional | boolean | Verify Server SSL certificate + +### Supported Actions +[test connectivity](#action-test-connectivity) - Validate the asset configuration for connectivity using the supplied configuration +[create node](#action-create-node) - Create a new node +[delete node](#action-delete-node) - Delete a node +[remove node](#action-remove-node) - Remove a node from a pool +[create pool](#action-create-pool) - Create a new pool +[add node](#action-add-node) - Add an existing node to a pool +[disable node](#action-disable-node) - Disable a node +[enable node](#action-enable-node) - Enable a node +[describe node](#action-describe-node) - Get information about a node +[get node stats](#action-get-node-stats) - Get stats of the node +[list nodes](#action-list-nodes) - Fetch a list of nodes \(if no value is provided, all nodes will be returned\) +[list pools](#action-list-pools) - Fetch a list of configured pools \(if no value is provided, all pools will be returned\) +[list members](#action-list-members) - Fetch a list of configured node members of a pool \(if no value is provided, all node members of a pool will be returned\) + +## action: 'test connectivity' +Validate the asset configuration for connectivity using the supplied configuration + +Type: **test** +Read only: **True** + +#### Action Parameters +No parameters are required for this action + +#### Action Output +No Output + +## action: 'create node' +Create a new node + +Type: **generic** +Read only: **False** + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**node\_name** | required | Name of the node to create | string | `f5 node name` +**partition\_name** | required | Name of the partition | string | `f5 partition name` +**ip\_address** | required | IP address of the new node | string | `ip` `ipv6` + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.ip\_address | string | `ip` `ipv6` +action\_result\.parameter\.node\_name | string | `f5 node name` +action\_result\.parameter\.partition\_name | string | `f5 partition name` +action\_result\.data\.\*\.address | string | `ip` +action\_result\.data\.\*\.connectionLimit | numeric | +action\_result\.data\.\*\.dynamicRatio | numeric | +action\_result\.data\.\*\.ephemeral | string | +action\_result\.data\.\*\.fqdn\.addressFamily | string | +action\_result\.data\.\*\.fqdn\.autopopulate | string | +action\_result\.data\.\*\.fqdn\.downInterval | numeric | +action\_result\.data\.\*\.fqdn\.interval | string | +action\_result\.data\.\*\.fullPath | string | +action\_result\.data\.\*\.generation | numeric | +action\_result\.data\.\*\.kind | string | +action\_result\.data\.\*\.logging | string | +action\_result\.data\.\*\.monitor | string | +action\_result\.data\.\*\.name | string | `f5 node name` +action\_result\.data\.\*\.partition | string | `f5 partition name` +action\_result\.data\.\*\.rateLimit | string | +action\_result\.data\.\*\.ratio | numeric | +action\_result\.data\.\*\.selfLink | string | `url` +action\_result\.data\.\*\.session | string | +action\_result\.data\.\*\.state | string | +action\_result\.summary\.node\_name | string | `f5 node name` +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | + +## action: 'delete node' +Delete a node + +Type: **generic** +Read only: **False** + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**node\_name** | required | Name of the node to delete | string | `f5 node name` + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.node\_name | string | `f5 node name` +action\_result\.data | string | +action\_result\.summary\.node\_name | string | +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | + +## action: 'remove node' +Remove a node from a pool + +Type: **generic** +Read only: **False** + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**node\_name** | required | Name of the node to remove | string | `f5 node name` +**port** | required | Port number | string | `port` +**pool\_name** | required | Name of the pool to remove the node from | string | `f5 pool name` + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.node\_name | string | `f5 node name` +action\_result\.parameter\.pool\_name | string | `f5 pool name` +action\_result\.parameter\.port | string | `port` +action\_result\.data | string | +action\_result\.summary\.node\_name | string | `f5 node name` +action\_result\.summary\.pool\_name | string | `f5 pool name` +action\_result\.summary\.port | string | `port` +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | + +## action: 'create pool' +Create a new pool + +Type: **generic** +Read only: **False** + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**pool\_name** | required | Name of the pool to create | string | `f5 pool name` +**pool\_description** | optional | Description of the pool | string | +**partition\_name** | required | Name of the partition | string | `f5 partition name` + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.partition\_name | string | `f5 partition name` +action\_result\.parameter\.pool\_description | string | +action\_result\.parameter\.pool\_name | string | `f5 pool name` +action\_result\.data\.\*\.allowNat | string | +action\_result\.data\.\*\.allowSnat | string | +action\_result\.data\.\*\.fullPath | string | +action\_result\.data\.\*\.generation | numeric | +action\_result\.data\.\*\.ignorePersistedWeight | string | +action\_result\.data\.\*\.ipTosToClient | string | +action\_result\.data\.\*\.ipTosToServer | string | +action\_result\.data\.\*\.kind | string | +action\_result\.data\.\*\.linkQosToClient | string | +action\_result\.data\.\*\.linkQosToServer | string | +action\_result\.data\.\*\.loadBalancingMode | string | +action\_result\.data\.\*\.membersReference\.isSubcollection | boolean | +action\_result\.data\.\*\.membersReference\.link | string | `url` +action\_result\.data\.\*\.minActiveMembers | numeric | +action\_result\.data\.\*\.minUpMembers | numeric | +action\_result\.data\.\*\.minUpMembersAction | string | +action\_result\.data\.\*\.minUpMembersChecking | string | +action\_result\.data\.\*\.name | string | `f5 pool name` +action\_result\.data\.\*\.partition | string | `f5 partition name` +action\_result\.data\.\*\.queueDepthLimit | numeric | +action\_result\.data\.\*\.queueOnConnectionLimit | string | +action\_result\.data\.\*\.queueTimeLimit | numeric | +action\_result\.data\.\*\.reselectTries | numeric | +action\_result\.data\.\*\.selfLink | string | `url` +action\_result\.data\.\*\.serviceDownAction | string | +action\_result\.data\.\*\.slowRampTime | numeric | +action\_result\.summary\.partition | string | `f5 partition name` +action\_result\.summary\.pool\_description | string | +action\_result\.summary\.pool\_name | string | `f5 pool name` +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | + +## action: 'add node' +Add an existing node to a pool + +Type: **generic** +Read only: **False** + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**node\_name** | required | Name of the node to add | string | `f5 node name` +**partition\_name** | required | Name of the partition to add node | string | `f5 partition name` +**port** | required | Port number | string | `port` +**pool\_name** | required | Name of the pool to add node member | string | `f5 pool name` + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.node\_name | string | `f5 node name` +action\_result\.parameter\.partition\_name | string | `f5 partition name` +action\_result\.parameter\.pool\_name | string | `f5 pool name` +action\_result\.parameter\.port | string | `port` +action\_result\.data\.\*\.address | string | `ip` +action\_result\.data\.\*\.connectionLimit | numeric | +action\_result\.data\.\*\.dynamicRatio | numeric | +action\_result\.data\.\*\.ephemeral | string | +action\_result\.data\.\*\.fqdn\.autopopulate | string | +action\_result\.data\.\*\.fullPath | string | +action\_result\.data\.\*\.generation | numeric | +action\_result\.data\.\*\.inheritProfile | string | +action\_result\.data\.\*\.kind | string | +action\_result\.data\.\*\.logging | string | +action\_result\.data\.\*\.monitor | string | +action\_result\.data\.\*\.name | string | `f5 node name` +action\_result\.data\.\*\.partition | string | `f5 partition name` +action\_result\.data\.\*\.priorityGroup | numeric | +action\_result\.data\.\*\.rateLimit | string | +action\_result\.data\.\*\.ratio | numeric | +action\_result\.data\.\*\.selfLink | string | `url` +action\_result\.data\.\*\.session | string | +action\_result\.data\.\*\.state | string | +action\_result\.summary\.node\_name | string | +action\_result\.summary\.pool\_name | string | `f5 pool name` +action\_result\.summary\.port | string | `port` +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | + +## action: 'disable node' +Disable a node + +Type: **contain** +Read only: **False** + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**node\_name** | required | Name of the node to disable | string | `f5 node name` + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.node\_name | string | `f5 node name` +action\_result\.data\.\*\.address | string | `ip` +action\_result\.data\.\*\.connectionLimit | numeric | +action\_result\.data\.\*\.description | string | +action\_result\.data\.\*\.dynamicRatio | numeric | +action\_result\.data\.\*\.ephemeral | string | +action\_result\.data\.\*\.fqdn\.addressFamily | string | +action\_result\.data\.\*\.fqdn\.autopopulate | string | +action\_result\.data\.\*\.fqdn\.downInterval | numeric | +action\_result\.data\.\*\.fqdn\.interval | string | +action\_result\.data\.\*\.fullPath | string | +action\_result\.data\.\*\.generation | numeric | +action\_result\.data\.\*\.kind | string | +action\_result\.data\.\*\.logging | string | +action\_result\.data\.\*\.monitor | string | +action\_result\.data\.\*\.name | string | `f5 node name` +action\_result\.data\.\*\.rateLimit | string | +action\_result\.data\.\*\.ratio | numeric | +action\_result\.data\.\*\.selfLink | string | `url` +action\_result\.data\.\*\.session | string | +action\_result\.data\.\*\.state | string | +action\_result\.summary\.node\_name | string | +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | + +## action: 'enable node' +Enable a node + +Type: **correct** +Read only: **False** + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**node\_name** | required | Name of the node to enable | string | `f5 node name` + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.node\_name | string | `f5 node name` +action\_result\.data\.\*\.address | string | `ip` +action\_result\.data\.\*\.connectionLimit | numeric | +action\_result\.data\.\*\.description | string | +action\_result\.data\.\*\.dynamicRatio | numeric | +action\_result\.data\.\*\.ephemeral | string | +action\_result\.data\.\*\.fqdn\.addressFamily | string | +action\_result\.data\.\*\.fqdn\.autopopulate | string | +action\_result\.data\.\*\.fqdn\.downInterval | numeric | +action\_result\.data\.\*\.fqdn\.interval | string | +action\_result\.data\.\*\.fullPath | string | +action\_result\.data\.\*\.generation | numeric | +action\_result\.data\.\*\.kind | string | +action\_result\.data\.\*\.logging | string | +action\_result\.data\.\*\.monitor | string | +action\_result\.data\.\*\.name | string | `f5 node name` +action\_result\.data\.\*\.rateLimit | string | +action\_result\.data\.\*\.ratio | numeric | +action\_result\.data\.\*\.selfLink | string | `url` +action\_result\.data\.\*\.session | string | +action\_result\.data\.\*\.state | string | +action\_result\.summary\.node\_name | string | +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | + +## action: 'describe node' +Get information about a node + +Type: **investigate** +Read only: **True** + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**node\_name** | required | Name of the node to describe | string | `f5 node name` + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.node\_name | string | `f5 node name` +action\_result\.data\.\*\.address | string | `ip` +action\_result\.data\.\*\.connectionLimit | numeric | +action\_result\.data\.\*\.dynamicRatio | numeric | +action\_result\.data\.\*\.ephemeral | string | +action\_result\.data\.\*\.fqdn\.addressFamily | string | +action\_result\.data\.\*\.fqdn\.autopopulate | string | +action\_result\.data\.\*\.fqdn\.downInterval | numeric | +action\_result\.data\.\*\.fqdn\.interval | string | +action\_result\.data\.\*\.fullPath | string | +action\_result\.data\.\*\.generation | numeric | +action\_result\.data\.\*\.kind | string | +action\_result\.data\.\*\.logging | string | +action\_result\.data\.\*\.monitor | string | +action\_result\.data\.\*\.name | string | `f5 node name` +action\_result\.data\.\*\.rateLimit | string | +action\_result\.data\.\*\.ratio | numeric | +action\_result\.data\.\*\.selfLink | string | `url` +action\_result\.data\.\*\.session | string | +action\_result\.data\.\*\.state | string | +action\_result\.summary\.state | string | +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | + +## action: 'get node stats' +Get stats of the node + +Type: **investigate** +Read only: **True** + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**node\_name** | required | Name of the node | string | `f5 node name` + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.node\_name | string | `f5 node name` +action\_result\.data\.\*\.addr\.description | string | +action\_result\.data\.\*\.curSessions\.value | numeric | +action\_result\.data\.\*\.monitorRule\.description | string | +action\_result\.data\.\*\.monitorStatus\.description | string | +action\_result\.data\.\*\.serverside\_bitsIn\.value | numeric | +action\_result\.data\.\*\.serverside\_bitsOut\.value | numeric | +action\_result\.data\.\*\.serverside\_curConns\.value | numeric | +action\_result\.data\.\*\.serverside\_maxConns\.value | numeric | +action\_result\.data\.\*\.serverside\_pktsIn\.value | numeric | +action\_result\.data\.\*\.serverside\_pktsOut\.value | numeric | +action\_result\.data\.\*\.serverside\_totConns\.value | numeric | +action\_result\.data\.\*\.sessionStatus\.description | string | +action\_result\.data\.\*\.status\_availabilityState\.description | string | +action\_result\.data\.\*\.status\_enabledState\.description | string | +action\_result\.data\.\*\.status\_statusReason\.description | string | +action\_result\.data\.\*\.tmName\.description | string | +action\_result\.data\.\*\.totRequests\.value | numeric | +action\_result\.summary\.num\_connections | numeric | +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | + +## action: 'list nodes' +Fetch a list of nodes \(if no value is provided, all nodes will be returned\) + +Type: **investigate** +Read only: **True** + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**max\_results** | optional | Max number of nodes to return | numeric | + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.max\_results | numeric | +action\_result\.data\.\*\.address | string | `ip` +action\_result\.data\.\*\.connectionLimit | numeric | +action\_result\.data\.\*\.description | string | +action\_result\.data\.\*\.dynamicRatio | numeric | +action\_result\.data\.\*\.ephemeral | string | +action\_result\.data\.\*\.fqdn\.addressFamily | string | +action\_result\.data\.\*\.fqdn\.autopopulate | string | +action\_result\.data\.\*\.fqdn\.downInterval | numeric | +action\_result\.data\.\*\.fqdn\.interval | string | +action\_result\.data\.\*\.fullPath | string | +action\_result\.data\.\*\.generation | numeric | +action\_result\.data\.\*\.kind | string | +action\_result\.data\.\*\.logging | string | +action\_result\.data\.\*\.monitor | string | +action\_result\.data\.\*\.name | string | `f5 node name` +action\_result\.data\.\*\.partition | string | `f5 partition name` +action\_result\.data\.\*\.rateLimit | string | +action\_result\.data\.\*\.ratio | numeric | +action\_result\.data\.\*\.selfLink | string | `url` +action\_result\.data\.\*\.session | string | +action\_result\.data\.\*\.state | string | +action\_result\.summary\.node\_names | string | +action\_result\.summary\.num\_nodes | numeric | +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | + +## action: 'list pools' +Fetch a list of configured pools \(if no value is provided, all pools will be returned\) + +Type: **investigate** +Read only: **True** + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**max\_results** | optional | Max number of pools to return | numeric | + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.max\_results | numeric | +action\_result\.data\.\*\.allowNat | string | +action\_result\.data\.\*\.allowSnat | string | +action\_result\.data\.\*\.description | string | +action\_result\.data\.\*\.fullPath | string | +action\_result\.data\.\*\.generation | numeric | +action\_result\.data\.\*\.ignorePersistedWeight | string | +action\_result\.data\.\*\.ipTosToClient | string | +action\_result\.data\.\*\.ipTosToServer | string | +action\_result\.data\.\*\.items\.\*\.addressStatus | string | +action\_result\.data\.\*\.items\.\*\.autoLasthop | string | +action\_result\.data\.\*\.items\.\*\.cmpEnabled | string | +action\_result\.data\.\*\.items\.\*\.connectionLimit | numeric | +action\_result\.data\.\*\.items\.\*\.creationTime | string | +action\_result\.data\.\*\.items\.\*\.destination | string | +action\_result\.data\.\*\.items\.\*\.enabled | boolean | +action\_result\.data\.\*\.items\.\*\.evictionProtected | string | +action\_result\.data\.\*\.items\.\*\.fullPath | string | +action\_result\.data\.\*\.items\.\*\.generation | numeric | +action\_result\.data\.\*\.items\.\*\.gtmScore | numeric | +action\_result\.data\.\*\.items\.\*\.ipProtocol | string | +action\_result\.data\.\*\.items\.\*\.kind | string | +action\_result\.data\.\*\.items\.\*\.lastModifiedTime | string | +action\_result\.data\.\*\.items\.\*\.mask | string | `ip` +action\_result\.data\.\*\.items\.\*\.mirror | string | +action\_result\.data\.\*\.items\.\*\.mobileAppTunnel | string | +action\_result\.data\.\*\.items\.\*\.name | string | +action\_result\.data\.\*\.items\.\*\.nat64 | string | +action\_result\.data\.\*\.items\.\*\.partition | string | `f5 partition name` +action\_result\.data\.\*\.items\.\*\.policiesReference\.isSubcollection | boolean | +action\_result\.data\.\*\.items\.\*\.policiesReference\.link | string | `url` +action\_result\.data\.\*\.items\.\*\.pool | string | +action\_result\.data\.\*\.items\.\*\.poolReference\.link | string | `url` +action\_result\.data\.\*\.items\.\*\.profilesReference\.isSubcollection | boolean | +action\_result\.data\.\*\.items\.\*\.profilesReference\.link | string | `url` +action\_result\.data\.\*\.items\.\*\.rateLimit | string | +action\_result\.data\.\*\.items\.\*\.rateLimitDstMask | numeric | +action\_result\.data\.\*\.items\.\*\.rateLimitMode | string | +action\_result\.data\.\*\.items\.\*\.rateLimitSrcMask | numeric | +action\_result\.data\.\*\.items\.\*\.selfLink | string | `url` +action\_result\.data\.\*\.items\.\*\.serviceDownImmediateAction | string | +action\_result\.data\.\*\.items\.\*\.source | string | +action\_result\.data\.\*\.items\.\*\.sourceAddressTranslation\.type | string | +action\_result\.data\.\*\.items\.\*\.sourcePort | string | +action\_result\.data\.\*\.items\.\*\.synCookieStatus | string | +action\_result\.data\.\*\.items\.\*\.translateAddress | string | +action\_result\.data\.\*\.items\.\*\.translatePort | string | +action\_result\.data\.\*\.items\.\*\.vlansDisabled | boolean | +action\_result\.data\.\*\.items\.\*\.vsIndex | numeric | +action\_result\.data\.\*\.kind | string | +action\_result\.data\.\*\.linkQosToClient | string | +action\_result\.data\.\*\.linkQosToServer | string | +action\_result\.data\.\*\.loadBalancingMode | string | +action\_result\.data\.\*\.membersReference\.isSubcollection | boolean | +action\_result\.data\.\*\.membersReference\.link | string | `url` +action\_result\.data\.\*\.minActiveMembers | numeric | +action\_result\.data\.\*\.minUpMembers | numeric | +action\_result\.data\.\*\.minUpMembersAction | string | +action\_result\.data\.\*\.minUpMembersChecking | string | +action\_result\.data\.\*\.monitor | string | +action\_result\.data\.\*\.name | string | `f5 pool name` +action\_result\.data\.\*\.partition | string | `f5 partition name` +action\_result\.data\.\*\.queueDepthLimit | numeric | +action\_result\.data\.\*\.queueOnConnectionLimit | string | +action\_result\.data\.\*\.queueTimeLimit | numeric | +action\_result\.data\.\*\.reselectTries | numeric | +action\_result\.data\.\*\.selfLink | string | `url` +action\_result\.data\.\*\.serviceDownAction | string | +action\_result\.data\.\*\.slowRampTime | numeric | +action\_result\.summary\.num\_pools | numeric | +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | + +## action: 'list members' +Fetch a list of configured node members of a pool \(if no value is provided, all node members of a pool will be returned\) + +Type: **investigate** +Read only: **True** + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**pool\_name** | required | Name of the pool | string | `f5 pool name` +**partition\_name** | required | Name of the partition | string | `f5 partition name` +**max\_results** | optional | Max number of members to return | numeric | + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.max\_results | numeric | +action\_result\.parameter\.partition\_name | string | `f5 partition name` +action\_result\.parameter\.pool\_name | string | `f5 pool name` +action\_result\.data\.\*\.address | string | `ip` +action\_result\.data\.\*\.connectionLimit | numeric | +action\_result\.data\.\*\.dynamicRatio | numeric | +action\_result\.data\.\*\.ephemeral | string | +action\_result\.data\.\*\.fqdn\.autopopulate | string | +action\_result\.data\.\*\.fullPath | string | +action\_result\.data\.\*\.generation | numeric | +action\_result\.data\.\*\.inheritProfile | string | +action\_result\.data\.\*\.kind | string | +action\_result\.data\.\*\.logging | string | +action\_result\.data\.\*\.monitor | string | +action\_result\.data\.\*\.name | string | `f5 node name` +action\_result\.data\.\*\.partition | string | `f5 partition name` +action\_result\.data\.\*\.priorityGroup | numeric | +action\_result\.data\.\*\.rateLimit | string | +action\_result\.data\.\*\.ratio | numeric | +action\_result\.data\.\*\.selfLink | string | `url` +action\_result\.data\.\*\.session | string | +action\_result\.data\.\*\.state | string | +action\_result\.summary\.members | string | +action\_result\.summary\.num\_members | numeric | +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | \ No newline at end of file diff --git a/__init__.py b/__init__.py index 55eadff..f7ee2da 100644 --- a/__init__.py +++ b/__init__.py @@ -1,6 +1,14 @@ # File: __init__.py # -# Copyright (c) 2019-2020 Splunk Inc. +# Copyright (c) 2019-2022 Splunk Inc. # -# SPLUNK CONFIDENTIAL - Use or disclosure of this material in whole or in part -# without a valid written license from Splunk Inc. is PROHIBITED. +# 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. diff --git a/docker-compose.yml b/docker-compose.yml deleted file mode 100644 index 6150455..0000000 --- a/docker-compose.yml +++ /dev/null @@ -1,24 +0,0 @@ -version: "3.2" - -services: - app_tester: - image: repo.splunk.com/splunk/infra/phantom_apps_tester:${IMAGE_TAG:-latest} - environment: - BUILD_USER_ID: ${USER:-localbuild} - TEST_BRANCH: ${TEST_BRANCH:-master} - WORKSPACE: /builds/phantom-apps - volumes: - - .:/builds/phantom-apps/${APP_REPO_NAME} - command: sleep 28800 - secrets: - - app_artf_token - - app_deploy_key - - gitlab_api_token - -secrets: - app_artf_token: - file: ~/.docker/secrets/app_artf_token - app_deploy_key: - file: ~/.docker/secrets/app_deploy_key - gitlab_api_token: - file: ~/.docker/secrets/gitlab_api_token diff --git a/exclude_files.txt b/exclude_files.txt index 9465409..559ce41 100644 --- a/exclude_files.txt +++ b/exclude_files.txt @@ -1,5 +1,6 @@ +docker-compose.yml +Makefile .git* .idea* -docker-compose.yml .gitlab-ci.yml -Makefile +whitesource-results diff --git a/f5bigipltm.json b/f5bigipltm.json index ea628bc..24fb902 100644 --- a/f5bigipltm.json +++ b/f5bigipltm.json @@ -9,10 +9,11 @@ "product_name": "Local Traffic Manager", "product_version_regex": ".*", "publisher": "Splunk", - "license": "Copyright (c) 2019-2020 Splunk Inc.", - "app_version": "2.0.3", + "license": "Copyright (c) 2019-2022 Splunk Inc.", + "app_version": "2.0.8", "python_version": "3", - "utctime_updated": "2020-04-08T21:21:47.000000Z", + "fips_compliant": true, + "utctime_updated": "2022-01-19T00:53:17.000000Z", "package_name": "phantom_f5bigipltm", "main_module": "f5bigipltm_connector.py", "min_phantom_version": "4.6.19142", @@ -3164,5 +3165,37 @@ }, "versions": "EQ(*)" } - ] + ], + "pip_dependencies": { + "wheel": [ + { + "module": "beautifulsoup4", + "input_file": "wheels/beautifulsoup4-4.9.1-py3-none-any.whl" + }, + { + "module": "certifi", + "input_file": "wheels/certifi-2021.10.8-py2.py3-none-any.whl" + }, + { + "module": "chardet", + "input_file": "wheels/chardet-3.0.4-py2.py3-none-any.whl" + }, + { + "module": "idna", + "input_file": "wheels/idna-2.10-py2.py3-none-any.whl" + }, + { + "module": "requests", + "input_file": "wheels/requests-2.25.0-py2.py3-none-any.whl" + }, + { + "module": "soupsieve", + "input_file": "wheels/soupsieve-2.3.1-py3-none-any.whl" + }, + { + "module": "urllib3", + "input_file": "wheels/urllib3-1.26.7-py2.py3-none-any.whl" + } + ] + } } \ No newline at end of file diff --git a/f5bigipltm_connector.py b/f5bigipltm_connector.py index 92f37b0..de15ea3 100644 --- a/f5bigipltm_connector.py +++ b/f5bigipltm_connector.py @@ -1,21 +1,28 @@ # File: f5bigipltm_connector.py # -# Copyright (c) 2019-2020 Splunk Inc. +# Copyright (c) 2019-2022 Splunk Inc. # -# SPLUNK CONFIDENTIAL - Use or disclosure of this material in whole or in part -# without a valid written license from Splunk Inc. is PROHIBITED. +# 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. +# +# +import ipaddress +import json +import sys -# Phantom App imports import phantom.app as phantom -from phantom.base_connector import BaseConnector -from phantom.action_result import ActionResult - -# Usage of the consts file is recommended import requests -import json -import ipaddress -import sys from bs4 import BeautifulSoup, UnicodeDammit +from phantom.action_result import ActionResult +from phantom.base_connector import BaseConnector class RetVal(tuple): @@ -93,7 +100,7 @@ def _process_json_response(self, r, action_result): else: error_msg = "Unable to find 'message' key in the JSON error response" message = "Error occurred while making the request. Status Code: {0}. Response Code: {1}. Message from server: {2}".format( - r.status_code, resp_json.get("code"), error_msg) + r.status_code, resp_json.get("code"), error_msg) else: # You should process the error returned in the json try: @@ -106,7 +113,8 @@ def _process_json_response(self, r, action_result): r.status_code, error_msg) except Exception as e: _, error_msg = self._get_error_message_from_exception(e) - message = "Unknown error occurred while processing the output response from the server. Status Code: {0}. Data from server: {1}".format(r.status_code, error_msg) + message = "Unknown error occurred while processing the output response from the server. " \ + "Status Code: {0}. Data from server: {1}".format(r.status_code, error_msg) return RetVal(action_result.set_status(phantom.APP_ERROR, message), None) @@ -206,8 +214,8 @@ def _make_rest_call(self, endpoint, action_result, method="get", data=None, **kw url = "{}{}".format(self._base_url, endpoint) except Exception as e: error_code, error_msg = self._get_error_message_from_exception(e) - return RetVal(action_result.set_status(phantom.APP_ERROR, "Error occurred while creating the REST URL for the API call. Error Code: {0}. Error Message: {1}".format( - error_code, error_msg)), None) + return RetVal(action_result.set_status(phantom.APP_ERROR, "Error occurred while creating the REST URL for the API call. " + "Error Code: {0}. Error Message: {1}".format(error_code, error_msg)), None) try: r = request_func( @@ -218,8 +226,8 @@ def _make_rest_call(self, endpoint, action_result, method="get", data=None, **kw **kwargs) except Exception as e: error_code, error_msg = self._get_error_message_from_exception(e) - return RetVal(action_result.set_status(phantom.APP_ERROR, "Error occurred while making the REST call to the F5 server. Error Code: {0}. Error Message: {1}".format( - error_code, error_msg)), None) + return RetVal(action_result.set_status(phantom.APP_ERROR, "Error occurred while making the REST call to the F5 server. " + "Error Code: {0}. Error Message: {1}".format(error_code, error_msg)), None) return self._process_response(r, action_result) @@ -260,7 +268,8 @@ def _handle_remove_node(self, param): return action_result.set_status(phantom.APP_ERROR, "Please enter the port in range of 0 to 65535") # make rest call - ret_val, response = self._make_rest_call('/mgmt/tm/ltm/pool/{0}/members/{1}:{2}'.format(pool_name, node_name, port), action_result, method="delete") + ret_val, response = self._make_rest_call('/mgmt/tm/ltm/pool/{0}/members/{1}:{2}'.format( + pool_name, node_name, port), action_result, method="delete") if (phantom.is_fail(ret_val)): return action_result.get_status() @@ -281,7 +290,8 @@ def _handle_add_node(self, param): action_result = self.add_action_result(ActionResult(dict(param))) node_name = self._handle_py_ver_compat_for_input_str(self._python_version, param['node_name']).replace('\\', '\\\\').replace('"', '\\"') port = param['port'] - partition_name = self._handle_py_ver_compat_for_input_str(self._python_version, param['partition_name']).replace('\\', '\\\\').replace('"', '\\"') + partition_name = self._handle_py_ver_compat_for_input_str(self._python_version, + param['partition_name']).replace('\\', '\\\\').replace('"', '\\"') pool_name = self._handle_py_ver_compat_for_input_str(self._python_version, param['pool_name']).replace('\\', '\\\\').replace('"', '\\"') try: @@ -362,7 +372,8 @@ def _handle_create_node(self, param): action_result = self.add_action_result(ActionResult(dict(param))) node = self._handle_py_ver_compat_for_input_str(self._python_version, param['node_name']).replace('\\', '\\\\').replace('"', '\\"') - partition = self._handle_py_ver_compat_for_input_str(self._python_version, param['partition_name']).replace('\\', '\\\\').replace('"', '\\"') + partition = self._handle_py_ver_compat_for_input_str(self._python_version, + param['partition_name']).replace('\\', '\\\\').replace('"', '\\"') address = param['ip_address'] json_str = '{{"name": "{}", "partition": "{}", "address": "{}"}}'.format(node, partition, address) @@ -409,7 +420,8 @@ def _handle_disable_node(self, param): param['session'] = 'user-disabled' # make rest call - ret_val, response = self._make_rest_call('/mgmt/tm/ltm/node/{0}'.format(node_name), action_result, method="patch", json={'session': 'user-disabled'}) + ret_val, response = self._make_rest_call('/mgmt/tm/ltm/node/{0}'.format( + node_name), action_result, method="patch", json={'session': 'user-disabled'}) if (phantom.is_fail(ret_val)): return action_result.get_status() @@ -432,7 +444,8 @@ def _handle_enable_node(self, param): param['session'] = 'user-enabled' # make rest call - ret_val, response = self._make_rest_call('/mgmt/tm/ltm/node/{0}'.format(node_name), action_result, method="patch", json={'session': 'user-enabled'}) + ret_val, response = self._make_rest_call('/mgmt/tm/ltm/node/{0}'.format( + node_name), action_result, method="patch", json={'session': 'user-enabled'}) if (phantom.is_fail(ret_val)): return action_result.get_status() @@ -532,15 +545,16 @@ def _handle_create_pool(self, param): action_result = self.add_action_result(ActionResult(dict(param))) pool_name = self._handle_py_ver_compat_for_input_str(self._python_version, param['pool_name']).replace('\\', '\\\\').replace('"', '\\"') - partition_name = self._handle_py_ver_compat_for_input_str(self._python_version, param['partition_name']).replace('\\', '\\\\').replace('"', '\\"') + partition_name = self._handle_py_ver_compat_for_input_str(self._python_version, + param['partition_name']).replace('\\', '\\\\').replace('"', '\\"') pool_description = param.get('pool_description') if pool_description: # The F5 server requires the below replacement for some special characters as mentioned below. # " --> \\\" which gets represented as \\\\\\\" in the Python string # \ --> \\\\ which gets represented as \\\\\\\\ in the Python string - pool_description = self._handle_py_ver_compat_for_input_str(self._python_version, param['pool_description']).replace("\\", "\\\\\\\\").replace( - '"', '\\\\\\"') + pool_description = self._handle_py_ver_compat_for_input_str(self._python_version, + param.get('pool_description')).replace("\\", "\\\\\\\\").replace('"', '\\\\\\"') json_str = '{{"name": "{0}", "partition": "{1}", "description": "{2}"}}'.format(pool_name, partition_name, pool_description) else: json_str = '{{"name": "{0}", "partition": "{1}"}}'.format(pool_name, partition_name) @@ -705,9 +719,10 @@ def finalize(self): if __name__ == '__main__': - import pudb import argparse + import pudb + pudb.set_trace() argparser = argparse.ArgumentParser() @@ -715,12 +730,14 @@ def finalize(self): 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) + argparser.add_argument('-v', '--verify', action='store_true', help='verify', required=False, default=False) args = argparser.parse_args() session_id = None username = args.username password = args.password + verify = args.verify if (username is not None and password is None): @@ -733,7 +750,7 @@ def finalize(self): login_url = F5BigipLtmConnector._get_phantom_base_url() + '/login' print("Accessing the Login page") - r = requests.get(login_url, verify=False) + r = requests.get(login_url, verify=verify, timeout=30) csrftoken = r.cookies['csrftoken'] data = dict() @@ -746,11 +763,11 @@ def finalize(self): headers['Referer'] = login_url print("Logging into Platform to get the session id") - r2 = requests.post(login_url, verify=False, data=data, headers=headers) + r2 = requests.post(login_url, verify=verify, data=data, headers=headers, timeout=30) session_id = r2.cookies['sessionid'] except Exception as e: print("Unable to get session id from the platform. Error: " + str(e)) - exit(1) + sys.exit(1) with open(args.input_test_json) as f: in_json = f.read() @@ -767,4 +784,4 @@ def finalize(self): ret_val = connector._handle_action(json.dumps(in_json), None) print(json.dumps(json.loads(ret_val), indent=4)) - exit(0) + sys.exit(0) diff --git a/logo_f5bigipltm.svg b/logo_f5bigipltm.svg index 484b39e..fd1cb90 100644 --- a/logo_f5bigipltm.svg +++ b/logo_f5bigipltm.svg @@ -1 +1 @@ -Asset 1 \ No newline at end of file +Asset 1 diff --git a/logo_f5bigipltm_dark.svg b/logo_f5bigipltm_dark.svg index a873b8d..6393f6e 100644 --- a/logo_f5bigipltm_dark.svg +++ b/logo_f5bigipltm_dark.svg @@ -1 +1 @@ -f5-logo-white \ No newline at end of file +f5-logo-white diff --git a/release_notes/1.0.2.md b/release_notes/1.0.2.md new file mode 100644 index 0000000..678549e --- /dev/null +++ b/release_notes/1.0.2.md @@ -0,0 +1,6 @@ +**F5 BIG-IP LTM Release Notes - Published by Splunk October 14, 2019** + + +**Version 1.0.2 - Released October 14, 2019** + +* Initial Release diff --git a/release_notes/2.0.3.md b/release_notes/2.0.3.md new file mode 100644 index 0000000..b6fbe4f --- /dev/null +++ b/release_notes/2.0.3.md @@ -0,0 +1,10 @@ +**F5 BIG-IP LTM Release Notes - Published by Splunk April 09, 2020** + + +**Version 2.0.3 - Released April 09, 2020** + +* Compatibility changes for Python 3 support +* Added a new action 'get node stats' +* Added pagination in the investigate actions +* Fixed the output table views +* Handled exceptions for Unicode character issues diff --git a/release_notes/2.0.8.md b/release_notes/2.0.8.md new file mode 100644 index 0000000..025877c --- /dev/null +++ b/release_notes/2.0.8.md @@ -0,0 +1,6 @@ +**F5 BIG-IP LTM Release Notes - Published by Splunk January 21, 2022** + + +**Version 2.0.8 - Released January 21, 2022** + +* Marked the app as FIPS Compliant [PAPP-22676] \ No newline at end of file diff --git a/release_notes/release_notes.html b/release_notes/release_notes.html new file mode 100644 index 0000000..64ddbb2 --- /dev/null +++ b/release_notes/release_notes.html @@ -0,0 +1,18 @@ +F5 BIG-IP LTM Release Notes - Published by Splunk January 21, 2022 +

+Version 2.0.8 - Released January 21, 2022 + +Version 2.0.3 - Released April 09, 2020 + +Version 1.0.2 - Released October 14, 2019 + diff --git a/release_notes/unreleased.md b/release_notes/unreleased.md new file mode 100644 index 0000000..fbcb2fd --- /dev/null +++ b/release_notes/unreleased.md @@ -0,0 +1 @@ +**Unreleased** diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..523a0ce --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +beautifulsoup4==4.9.1 +requests==2.25.0 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..127a08b --- /dev/null +++ b/tox.ini @@ -0,0 +1,7 @@ +[flake8] +max-line-length = 145 +max-complexity = 28 +ignore = F403,E128,E126,E111,E121,E127,E731,E201,E202,F405,E722,D,W292 + +[isort] +line_length = 145 diff --git a/wheels/beautifulsoup4-4.9.1-py3-none-any.whl b/wheels/beautifulsoup4-4.9.1-py3-none-any.whl new file mode 100644 index 0000000..080b2f8 Binary files /dev/null and b/wheels/beautifulsoup4-4.9.1-py3-none-any.whl differ diff --git a/wheels/certifi-2021.10.8-py2.py3-none-any.whl b/wheels/certifi-2021.10.8-py2.py3-none-any.whl new file mode 100644 index 0000000..fbcb86b Binary files /dev/null and b/wheels/certifi-2021.10.8-py2.py3-none-any.whl differ diff --git a/wheels/chardet-3.0.4-py2.py3-none-any.whl b/wheels/chardet-3.0.4-py2.py3-none-any.whl new file mode 100644 index 0000000..d276977 Binary files /dev/null and b/wheels/chardet-3.0.4-py2.py3-none-any.whl differ diff --git a/wheels/idna-2.10-py2.py3-none-any.whl b/wheels/idna-2.10-py2.py3-none-any.whl new file mode 100644 index 0000000..41225cb Binary files /dev/null and b/wheels/idna-2.10-py2.py3-none-any.whl differ diff --git a/wheels/requests-2.25.0-py2.py3-none-any.whl b/wheels/requests-2.25.0-py2.py3-none-any.whl new file mode 100644 index 0000000..c3f28e5 Binary files /dev/null and b/wheels/requests-2.25.0-py2.py3-none-any.whl differ diff --git a/wheels/soupsieve-2.3.1-py3-none-any.whl b/wheels/soupsieve-2.3.1-py3-none-any.whl new file mode 100644 index 0000000..85d33de Binary files /dev/null and b/wheels/soupsieve-2.3.1-py3-none-any.whl differ diff --git a/wheels/urllib3-1.26.7-py2.py3-none-any.whl b/wheels/urllib3-1.26.7-py2.py3-none-any.whl new file mode 100644 index 0000000..62189e6 Binary files /dev/null and b/wheels/urllib3-1.26.7-py2.py3-none-any.whl differ