[MC-492][MC-694][MC-491][MC-726] Add Get Blocked Hosts and Block Host actions to Cisco ASA

[dsliwinski-r7]

Proposed Changes

Description

Describe the proposed changes:

• Add Get Blocked Hosts action to Cisco ASA
• Add Block Host action to Cisco ASA
• Add unit test for Get Blocked Hosts and Block Host actions

PR Requirements

Developers, verify you have completed the following items by checking them off:

Testing

Unit Tests

Review our documentation on generating and writing plugin unit tests

• Unit tests written for any new or updated code

In-Product Tests

If you are an InsightConnect customer or have access to an InsightConnect instance, the following in-product tests should be done:

• Screenshot of job output with the plugin changes
• Screenshot of the changed connection, actions, or triggers input within the InsightConnect workflow builder

Style

Review the style guide

• For dependencies, pin OS package and Python package versions
• For security, set least privileged account with USER nobody in the Dockerfile when possible
• For size, use the slim SDK images when possible: komand/python-3-37-slim-plugin and komand/python-3-37-plugin
• For error handling, use of PluginException and ConnectionTestException
• For logging, use self.logger
• For docs, use changelog style
• For docs, validate markdown with make validate which calls mdl to lint help.md

Functional Checklist

• Work fully completed
• Functional
  • Any new actions/triggers include JSON test files in the tests/ directory created with icon-plugin run -c sample $action > tests/$action.json
  • Tests should all pass unless it's a negative test. Negative tests have a naming convention of tests/$action_bad.json
  • Unsuccessful tests should fail by raising an exception causing the plugin to die and an object should be returned on successful test
  • Add functioning test results to PR, sanitize any output if necessary
    • Single action/trigger icon-plugin run -T tests/example.json --debug --jq
    • All actions/triggers shortcut icon-plugin run -T all --debug --jq (use PR format at end)
  • Add functioning run results to PR, sanitize any output if necessary
    • Single action/trigger icon-plugin run -R tests/example.json --debug --jq
    • All actions/triggers shortcut icon-plugin run -R all --debug --jq (use PR format at end)

Assessment

Run

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\n",
    "meta": {},
    "output": {
      "success": true
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/block_host.json

Details

{
  "body": {
    "error": "An error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nshun 198.51.100.100 198.51.100.1010 443 443 tcp\\n                    ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}",
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\nAn error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nshun 198.51.100.100 198.51.100.1010 443 443 tcp\\n                    ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}\nTraceback (most recent call last):\n  File \"/usr/local/lib/python3.8/site-packages/insightconnect_plugin_runtime-4.2.0-py3.8.egg/insightconnect_plugin_runtime/plugin.py\", line 326, in handle_step\n    output = self.start_step(\n  File \"/usr/local/lib/python3.8/site-packages/insightconnect_plugin_runtime-4.2.0-py3.8.egg/insightconnect_plugin_runtime/plugin.py\", line 476, in start_step\n    output = func(params)\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/actions/block_host/action.py\", line 15, in run\n    Output.SUCCESS: self.connection.cisco_asa_api.block_host(\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 99, in block_host\n    self.cli([f\"shun {source_ip} {destination_ip} {source_port} {destination_port} {protocol}\"])\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 79, in cli\n    return self._call_api(\"POST\", \"cli\", json_data={\"commands\": commands})\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 162, in _call_api\n    raise PluginException(preset=PluginException.Preset.UNKNOWN, data=response_data)\ninsightconnect_plugin_runtime.exceptions.PluginException: An error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nshun 198.51.100.100 198.51.100.1010 443 443 tcp\\n                    ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}\n",
    "meta": {},
    "status": "error"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/block_host_invalid_dest_ip_bad.json

Details

{
  "body": {
    "error": "An error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nshun 198.51.100.1000 198.51.100.101 443 443 tcp\\n     ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}",
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\nAn error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nshun 198.51.100.1000 198.51.100.101 443 443 tcp\\n     ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}\nTraceback (most recent call last):\n  File \"/usr/local/lib/python3.8/site-packages/insightconnect_plugin_runtime-4.2.0-py3.8.egg/insightconnect_plugin_runtime/plugin.py\", line 326, in handle_step\n    output = self.start_step(\n  File \"/usr/local/lib/python3.8/site-packages/insightconnect_plugin_runtime-4.2.0-py3.8.egg/insightconnect_plugin_runtime/plugin.py\", line 476, in start_step\n    output = func(params)\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/actions/block_host/action.py\", line 15, in run\n    Output.SUCCESS: self.connection.cisco_asa_api.block_host(\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 99, in block_host\n    self.cli([f\"shun {source_ip} {destination_ip} {source_port} {destination_port} {protocol}\"])\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 79, in cli\n    return self._call_api(\"POST\", \"cli\", json_data={\"commands\": commands})\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 162, in _call_api\n    raise PluginException(preset=PluginException.Preset.UNKNOWN, data=response_data)\ninsightconnect_plugin_runtime.exceptions.PluginException: An error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nshun 198.51.100.1000 198.51.100.101 443 443 tcp\\n     ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}\n",
    "meta": {},
    "status": "error"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/block_host_invalid_ip_bad.json

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\n",
    "meta": {},
    "output": {
      "success": true
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/block_host_only_source_ip.json

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\n",
    "meta": {},
    "output": {
      "success": true
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/block_host_without_dest_ip.json

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\n",
    "meta": {},
    "output": {
      "success": true
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/block_host_without_ports.json

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\n",
    "meta": {},
    "output": {
      "success": true
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/block_host_without_protocol.json

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: get_blocked_hosts\n",
    "meta": {},
    "output": {
      "hosts": [
        {
          "dest_ip": "198.51.100.101",
          "dest_port": "443",
          "protocol": "0",
          "source_ip": "198.51.100.100",
          "source_port": "443"
        }
      ]
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/get_blocked_hosts.json

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\n",
    "meta": {},
    "output": {
      "success": true
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/unblock_host.json

Details

{
  "body": {
    "error": "An error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nno shun 198.51.100.1001\\n        ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}",
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\nAn error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nno shun 198.51.100.1001\\n        ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}\nTraceback (most recent call last):\n  File \"/usr/local/lib/python3.8/site-packages/insightconnect_plugin_runtime-4.2.0-py3.8.egg/insightconnect_plugin_runtime/plugin.py\", line 326, in handle_step\n    output = self.start_step(\n  File \"/usr/local/lib/python3.8/site-packages/insightconnect_plugin_runtime-4.2.0-py3.8.egg/insightconnect_plugin_runtime/plugin.py\", line 476, in start_step\n    output = func(params)\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/actions/block_host/action.py\", line 15, in run\n    Output.SUCCESS: self.connection.cisco_asa_api.block_host(\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 101, in block_host\n    self.cli([f\"no shun {source_ip}\"])\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 79, in cli\n    return self._call_api(\"POST\", \"cli\", json_data={\"commands\": commands})\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 162, in _call_api\n    raise PluginException(preset=PluginException.Preset.UNKNOWN, data=response_data)\ninsightconnect_plugin_runtime.exceptions.PluginException: An error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nno shun 198.51.100.1001\\n        ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}\n",
    "meta": {},
    "status": "error"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/unblock_host_invalid_ip_bad.json

Details

[*] Validating plugin with all validators at .

[*] Running Integration Validators...
[*] Executing validator HelpValidator
[*] Executing validator ChangelogValidator
[*] Executing validator CloudReadyConnectionCredentialTokenValidator
[*] Executing validator RequiredKeysValidator
[*] Executing validator UseCaseValidator
[*] Executing validator SpecPropertiesValidator
[*] Executing validator SpecVersionValidator
[*] Executing validator FilesValidator
[*] Executing validator TagValidator
[*] Executing validator DescriptionValidator
[*] Executing validator TitleValidator
[*] Executing validator VendorValidator
[*] Executing validator DefaultValueValidator
[*] Executing validator IconValidator
[*] Executing validator RequiredValidator
[*] Executing validator VersionValidator
[*] Executing validator DockerfileParentValidator
[*] Executing validator ProfanityValidator
[*] Executing validator AcronymValidator
[*] Executing validator JSONValidator
[*] Executing validator OutputValidator
[*] Executing validator RegenerationValidator
[*] Executing validator HelpInputOutputValidator
[*] Executing validator SupportValidator
[*] Executing validator RuntimeValidator
[*] Executing validator VersionPinValidator
[*] Executing validator EncodingValidator
[*] Executing validator ExampleInputValidator
[*] Executing validator CloudReadyValidator
[*] Executing validator SupportedVersionValidator
[*] Executing validator UnapprovedKeywordsValidator
[*] Executing validator HelpExampleValidator
[*] Executing validator ExceptionValidator
[*] Executing validator CredentialsValidator
[*] Executing validator PasswordValidator
[*] Executing validator PrintValidator
[*] Executing validator ConfidentialValidator
[*] Executing validator DockerValidator
[*] Executing validator URLValidator
WARNING: URLs found that return a 4xx code. Verify they are publicly accessible and if not, update with a working URL.
violation: help.md[316]: https://example.com:443/api/objects/networkobjects/ASA_Demo_NObj_00
[*] Plugin failed validation! The following validation errors occurred:

Validator "TitleValidator" failed! 
	Cause: ("actions key 'check_if_address_object_in_group' error.", ValidationException('English articles and conjunctions should be lowercase when in the middle of the sentence: "a", "an", "as", "also", "and", "of", "the", "but", "from", "when", "in", "out", "if", "than", "where", "when", "while", "that", "by", "with", "to", "so", "for", "or", "nor", "by", "then", "after", "before", "is", "on", "at"'))


----
[*] Total time elapsed: 31616.931999999997ms

icon-validate --all .

Details

[*] Use ``make menu`` for available targets
[*] Including available Makefiles: ../../tools/Makefiles/Helpers.mk ../../tools/Makefiles/Colors.mk
--
[*] Running validators
[*] Validating plugin at .

[*] Running Integration Validators...
[*] Executing validator HelpValidator
[*] Executing validator ChangelogValidator
[*] Executing validator CloudReadyConnectionCredentialTokenValidator
[*] Executing validator RequiredKeysValidator
[*] Executing validator UseCaseValidator
[*] Executing validator SpecPropertiesValidator
[*] Executing validator SpecVersionValidator
[*] Executing validator FilesValidator
[*] Executing validator TagValidator
[*] Executing validator DescriptionValidator
[*] Executing validator TitleValidator
[*] Executing validator VendorValidator
[*] Executing validator DefaultValueValidator
[*] Executing validator IconValidator
[*] Executing validator RequiredValidator
[*] Executing validator VersionValidator
[*] Executing validator DockerfileParentValidator
[*] Executing validator ProfanityValidator
[*] Executing validator AcronymValidator
[*] Executing validator JSONValidator
[*] Executing validator OutputValidator
[*] Executing validator RegenerationValidator
[*] Executing validator HelpInputOutputValidator
[*] Executing validator SupportValidator
[*] Executing validator RuntimeValidator
[*] Executing validator VersionPinValidator
[*] Executing validator EncodingValidator
[*] Executing validator ExampleInputValidator
[*] Executing validator CloudReadyValidator
[*] Executing validator SupportedVersionValidator
[*] Executing validator UnapprovedKeywordsValidator
[*] Executing validator HelpExampleValidator
[*] Plugin failed validation! The following validation errors occurred:

Validator "TitleValidator" failed! 
	Cause: ("actions key 'check_if_address_object_in_group' error.", ValidationException('English articles and conjunctions should be lowercase when in the middle of the sentence: "a", "an", "as", "also", "and", "of", "the", "but", "from", "when", "in", "out", "if", "than", "where", "when", "while", "that", "by", "with", "to", "so", "for", "or", "nor", "by", "then", "after", "before", "is", "on", "at"'))


----
[*] Total time elapsed: 3482.163ms

make validate

Test

Autogenerate with:

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\n",
    "meta": {},
    "output": {
      "success": true
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug test < tests/block_host.json

[dsliwinski-r7]

@mrinehart-r7 @mberezin-r7 @jrose-r7 Hi! I added a new action Block Host to this PR.

Assessment

Run

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\n",
    "meta": {},
    "output": {
      "success": true
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/block_host.json

Details

{
  "body": {
    "error": "An error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nshun 198.51.100.100 198.51.100.1010 443 443 tcp\\n                    ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}",
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\nAn error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nshun 198.51.100.100 198.51.100.1010 443 443 tcp\\n                    ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}\nTraceback (most recent call last):\n  File \"/usr/local/lib/python3.8/site-packages/insightconnect_plugin_runtime-4.2.0-py3.8.egg/insightconnect_plugin_runtime/plugin.py\", line 326, in handle_step\n    output = self.start_step(\n  File \"/usr/local/lib/python3.8/site-packages/insightconnect_plugin_runtime-4.2.0-py3.8.egg/insightconnect_plugin_runtime/plugin.py\", line 476, in start_step\n    output = func(params)\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/actions/block_host/action.py\", line 15, in run\n    Output.SUCCESS: self.connection.cisco_asa_api.block_host(\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 99, in block_host\n    self.cli([f\"shun {source_ip} {destination_ip} {source_port} {destination_port} {protocol}\"])\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 79, in cli\n    return self._call_api(\"POST\", \"cli\", json_data={\"commands\": commands})\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 162, in _call_api\n    raise PluginException(preset=PluginException.Preset.UNKNOWN, data=response_data)\ninsightconnect_plugin_runtime.exceptions.PluginException: An error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nshun 198.51.100.100 198.51.100.1010 443 443 tcp\\n                    ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}\n",
    "meta": {},
    "status": "error"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/block_host_invalid_dest_ip_bad.json

Details

{
  "body": {
    "error": "An error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nshun 198.51.100.1000 198.51.100.101 443 443 tcp\\n     ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}",
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\nAn error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nshun 198.51.100.1000 198.51.100.101 443 443 tcp\\n     ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}\nTraceback (most recent call last):\n  File \"/usr/local/lib/python3.8/site-packages/insightconnect_plugin_runtime-4.2.0-py3.8.egg/insightconnect_plugin_runtime/plugin.py\", line 326, in handle_step\n    output = self.start_step(\n  File \"/usr/local/lib/python3.8/site-packages/insightconnect_plugin_runtime-4.2.0-py3.8.egg/insightconnect_plugin_runtime/plugin.py\", line 476, in start_step\n    output = func(params)\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/actions/block_host/action.py\", line 15, in run\n    Output.SUCCESS: self.connection.cisco_asa_api.block_host(\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 99, in block_host\n    self.cli([f\"shun {source_ip} {destination_ip} {source_port} {destination_port} {protocol}\"])\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 79, in cli\n    return self._call_api(\"POST\", \"cli\", json_data={\"commands\": commands})\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 162, in _call_api\n    raise PluginException(preset=PluginException.Preset.UNKNOWN, data=response_data)\ninsightconnect_plugin_runtime.exceptions.PluginException: An error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nshun 198.51.100.1000 198.51.100.101 443 443 tcp\\n     ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}\n",
    "meta": {},
    "status": "error"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/block_host_invalid_ip_bad.json

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\n",
    "meta": {},
    "output": {
      "success": true
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/block_host_only_source_ip.json

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\n",
    "meta": {},
    "output": {
      "success": true
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/block_host_without_dest_ip.json

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\n",
    "meta": {},
    "output": {
      "success": true
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/block_host_without_ports.json

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\n",
    "meta": {},
    "output": {
      "success": true
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/block_host_without_protocol.json

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: get_blocked_hosts\n",
    "meta": {},
    "output": {
      "hosts": [
        {
          "dest_ip": "198.51.100.101",
          "dest_port": "443",
          "protocol": "0",
          "source_ip": "198.51.100.100",
          "source_port": "443"
        }
      ]
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/get_blocked_hosts.json

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\n",
    "meta": {},
    "output": {
      "success": true
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/unblock_host.json

Details

{
  "body": {
    "error": "An error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nno shun 198.51.100.1001\\n        ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}",
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\nAn error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nno shun 198.51.100.1001\\n        ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}\nTraceback (most recent call last):\n  File \"/usr/local/lib/python3.8/site-packages/insightconnect_plugin_runtime-4.2.0-py3.8.egg/insightconnect_plugin_runtime/plugin.py\", line 326, in handle_step\n    output = self.start_step(\n  File \"/usr/local/lib/python3.8/site-packages/insightconnect_plugin_runtime-4.2.0-py3.8.egg/insightconnect_plugin_runtime/plugin.py\", line 476, in start_step\n    output = func(params)\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/actions/block_host/action.py\", line 15, in run\n    Output.SUCCESS: self.connection.cisco_asa_api.block_host(\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 101, in block_host\n    self.cli([f\"no shun {source_ip}\"])\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 79, in cli\n    return self._call_api(\"POST\", \"cli\", json_data={\"commands\": commands})\n  File \"/usr/local/lib/python3.8/site-packages/cisco_asa_rapid7_plugin-1.5.0-py3.8.egg/icon_cisco_asa/util/api.py\", line 162, in _call_api\n    raise PluginException(preset=PluginException.Preset.UNKNOWN, data=response_data)\ninsightconnect_plugin_runtime.exceptions.PluginException: An error occurred during plugin execution!\n\nSomething unexpected occurred. Check the logs and if the issue persists please contact support. Response was: {\"response\":[\"\\nno shun 198.51.100.1001\\n        ^\\nERROR: %!I(MISSING)nvalid Hostname\\n\"]}\n",
    "meta": {},
    "status": "error"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug run < tests/unblock_host_invalid_ip_bad.json

Details

[*] Validating plugin with all validators at .

[*] Running Integration Validators...
[*] Executing validator HelpValidator
[*] Executing validator ChangelogValidator
[*] Executing validator CloudReadyConnectionCredentialTokenValidator
[*] Executing validator RequiredKeysValidator
[*] Executing validator UseCaseValidator
[*] Executing validator SpecPropertiesValidator
[*] Executing validator SpecVersionValidator
[*] Executing validator FilesValidator
[*] Executing validator TagValidator
[*] Executing validator DescriptionValidator
[*] Executing validator TitleValidator
[*] Executing validator VendorValidator
[*] Executing validator DefaultValueValidator
[*] Executing validator IconValidator
[*] Executing validator RequiredValidator
[*] Executing validator VersionValidator
[*] Executing validator DockerfileParentValidator
[*] Executing validator ProfanityValidator
[*] Executing validator AcronymValidator
[*] Executing validator JSONValidator
[*] Executing validator OutputValidator
[*] Executing validator RegenerationValidator
[*] Executing validator HelpInputOutputValidator
[*] Executing validator SupportValidator
[*] Executing validator RuntimeValidator
[*] Executing validator VersionPinValidator
[*] Executing validator EncodingValidator
[*] Executing validator ExampleInputValidator
[*] Executing validator CloudReadyValidator
[*] Executing validator SupportedVersionValidator
[*] Executing validator UnapprovedKeywordsValidator
[*] Executing validator HelpExampleValidator
[*] Executing validator ExceptionValidator
[*] Executing validator CredentialsValidator
[*] Executing validator PasswordValidator
[*] Executing validator PrintValidator
[*] Executing validator ConfidentialValidator
[*] Executing validator DockerValidator
[*] Executing validator URLValidator
WARNING: URLs found that return a 4xx code. Verify they are publicly accessible and if not, update with a working URL.
violation: help.md[316]: https://example.com:443/api/objects/networkobjects/ASA_Demo_NObj_00
[*] Plugin failed validation! The following validation errors occurred:

Validator "TitleValidator" failed! 
	Cause: ("actions key 'check_if_address_object_in_group' error.", ValidationException('English articles and conjunctions should be lowercase when in the middle of the sentence: "a", "an", "as", "also", "and", "of", "the", "but", "from", "when", "in", "out", "if", "than", "where", "when", "while", "that", "by", "with", "to", "so", "for", "or", "nor", "by", "then", "after", "before", "is", "on", "at"'))


----
[*] Total time elapsed: 31616.931999999997ms

icon-validate --all .

Details

[*] Use ``make menu`` for available targets
[*] Including available Makefiles: ../../tools/Makefiles/Helpers.mk ../../tools/Makefiles/Colors.mk
--
[*] Running validators
[*] Validating plugin at .

[*] Running Integration Validators...
[*] Executing validator HelpValidator
[*] Executing validator ChangelogValidator
[*] Executing validator CloudReadyConnectionCredentialTokenValidator
[*] Executing validator RequiredKeysValidator
[*] Executing validator UseCaseValidator
[*] Executing validator SpecPropertiesValidator
[*] Executing validator SpecVersionValidator
[*] Executing validator FilesValidator
[*] Executing validator TagValidator
[*] Executing validator DescriptionValidator
[*] Executing validator TitleValidator
[*] Executing validator VendorValidator
[*] Executing validator DefaultValueValidator
[*] Executing validator IconValidator
[*] Executing validator RequiredValidator
[*] Executing validator VersionValidator
[*] Executing validator DockerfileParentValidator
[*] Executing validator ProfanityValidator
[*] Executing validator AcronymValidator
[*] Executing validator JSONValidator
[*] Executing validator OutputValidator
[*] Executing validator RegenerationValidator
[*] Executing validator HelpInputOutputValidator
[*] Executing validator SupportValidator
[*] Executing validator RuntimeValidator
[*] Executing validator VersionPinValidator
[*] Executing validator EncodingValidator
[*] Executing validator ExampleInputValidator
[*] Executing validator CloudReadyValidator
[*] Executing validator SupportedVersionValidator
[*] Executing validator UnapprovedKeywordsValidator
[*] Executing validator HelpExampleValidator
[*] Plugin failed validation! The following validation errors occurred:

Validator "TitleValidator" failed! 
	Cause: ("actions key 'check_if_address_object_in_group' error.", ValidationException('English articles and conjunctions should be lowercase when in the middle of the sentence: "a", "an", "as", "also", "and", "of", "the", "but", "from", "when", "in", "out", "if", "than", "where", "when", "while", "that", "by", "with", "to", "so", "for", "or", "nor", "by", "then", "after", "before", "is", "on", "at"'))


----
[*] Total time elapsed: 3482.163ms

make validate

Test

Autogenerate with:

Details

{
  "body": {
    "log": "Connect: Connecting...\nrapid7/Cisco Adaptive Security Appliance:1.5.0. Step name: block_host\n",
    "meta": {},
    "output": {
      "success": true
    },
    "status": "ok"
  },
  "type": "action_event",
  "version": "v1"
}

docker run --rm -i rapid7/cisco_asa:1.5.0 --debug test < tests/block_host.json

[pmara-r7]

Just read through the validation issues.
For the title validation issue, its an easy fix but would require increasing a major version instead of a minor version (not fun for customers).
A bunch of the prospector ones are annoying as well, to summarize:

• a boolean 'if' expression has 6 predicates (if a and b and c and d ... with 6 letters)
• unhappy with the constant '0.0.0.0', but afaict, we want to use that here...?
• we don't use the params arg in the 'get_blocked_hosts' action because the only thing needed for that is connections, not further input.
• doesn't like if response.status_code == 201 ... and would prefer if 201 in response.status_code

[pmara-r7]

@mrinehart-r7 which of the above need fixing?

[mrinehart-r7]

Just read through the validation issues. For the title validation issue, its an easy fix but would require increasing a major version instead of a minor version (not fun for customers). A bunch of the prospector ones are annoying as well, to summarize:

• a boolean 'if' expression has 6 predicates (if a and b and c and d ... with 6 letters) ignore
• unhappy with the constant '0.0.0.0', but afaict, we want to use that here...? ignore
• we don't use the params arg in the 'get_blocked_hosts' action because the only thing needed for that is connections, not further input. ignore
• doesn't like if response.status_code == 201 ... and would prefer if 201 in response.status_code ignore

We can ignore all of those - @dsliwinski-r7 can you add ignore comments to those lines to tell prospector to ignore those issues?

[pmara-r7]

Fixing the validator would require a increasing the major version, something that would cause more headache for the end user than what it is worth