added example plugin

Author: TKuzas-R7

.github/workflows/pypiPublishProd.yml

@@ -14,9 +14,9 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.9'
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
 
     - name: Install dependencies
       run: |

plugins/base64/.CHECKSUM

@@ -0,0 +1,19 @@
+{
+	"spec": "e50ed0cd4706f4f43f397c6f50426c8b",
+	"manifest": "d8d14059401870cc978c7210e6cbaa8c",
+	"setup": "fb701aee1efeb9e7f47a85025f71afad",
+	"schemas": [
+		{
+			"identifier": "decode/schema.py",
+			"hash": "54af457e2d290878d2aea68d728e4d91"
+		},
+		{
+			"identifier": "encode/schema.py",
+			"hash": "bed9f4dc2caf31b07fc5452c04d45fbd"
+		},
+		{
+			"identifier": "connection/schema.py",
+			"hash": "bd524b567f9638ba1c6f7e0c9e45ff2e"
+		}
+	]
+}

plugins/base64/.dockerignore

@@ -0,0 +1,9 @@
+unit_test/**/*
+unit_test
+examples/**/*
+examples
+tests
+tests/**/*
+**/*.json
+**/*.tar
+**/*.gz

plugins/base64/Dockerfile

@@ -0,0 +1,20 @@
+FROM rapid7/insightconnect-python-3-38-plugin:4
+
+LABEL organization=rapid7
+LABEL sdk=python
+
+WORKDIR /python/src
+
+ADD ./plugin.spec.yaml /plugin.spec.yaml
+ADD ./requirements.txt /python/src/requirements.txt
+
+RUN if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+ADD . /python/src
+
+RUN	python setup.py build && python setup.py install
+
+# User to run plugin code. The two supported users are: root, nobody
+USER nobody
+
+ENTRYPOINT ["/usr/local/bin/komand_base64"]

plugins/base64/Makefile

@@ -0,0 +1,53 @@
+# Include other Makefiles for improved functionality
+INCLUDE_DIR = ../../tools/Makefiles
+MAKEFILES := $(wildcard $(INCLUDE_DIR)/*.mk)
+# We can't guarantee customers will have the include files
+# - prefix to ignore Makefiles when not present
+# https://www.gnu.org/software/make/manual/html_node/Include.html
+-include $(MAKEFILES)
+
+ifneq ($(MAKEFILES),)
+  $(info [$(YELLOW)*$(NORMAL)] Use ``make menu`` for available targets)
+  $(info [$(YELLOW)*$(NORMAL)] Including available Makefiles: $(MAKEFILES))
+  $(info --)
+else
+  $(warning Makefile includes directory not present: $(INCLUDE_DIR))
+endif
+
+VERSION?=$(shell grep '^version: ' plugin.spec.yaml | sed 's/version: //')
+NAME?=$(shell grep '^name: ' plugin.spec.yaml | sed 's/name: //')
+VENDOR?=$(shell grep '^vendor: ' plugin.spec.yaml | sed 's/vendor: //')
+CWD?=$(shell basename $(PWD))
+_NAME?=$(shell echo $(NAME) | awk '{ print toupper(substr($$0,1,1)) tolower(substr($$0,2)) }')
+PKG=$(VENDOR)-$(NAME)-$(VERSION).tar.gz
+
+# Set default target explicitly. Make's default behavior is the first target in the Makefile.
+# We don't want that behavior due to includes which are read first
+.DEFAULT_GOAL := default # Make >= v3.80 (make -version)
+
+
+default: image tarball
+
+tarball:
+	$(info [$(YELLOW)*$(NORMAL)] Creating plugin tarball)
+	rm -rf build
+	rm -rf $(PKG)
+	tar -cvzf $(PKG) --exclude=$(PKG) --exclude=tests --exclude=run.sh *
+
+image:
+	$(info [$(YELLOW)*$(NORMAL)] Building plugin image)
+	docker build --pull -t $(VENDOR)/$(NAME):$(VERSION) .
+	docker tag $(VENDOR)/$(NAME):$(VERSION) $(VENDOR)/$(NAME):latest
+
+regenerate:
+	$(info [$(YELLOW)*$(NORMAL)] Refreshing schema from plugin.spec.yaml)
+	insight-plugin refresh
+
+export: image
+	$(info [$(YELLOW)*$(NORMAL)] Exporting docker image)
+	@printf "\n ---> Exporting Docker image to ./$(VENDOR)_$(NAME)_$(VERSION).tar\n"
+	@docker save $(VENDOR)/$(NAME):$(VERSION) | gzip > $(VENDOR)_$(NAME)_$(VERSION).tar
+
+# Make will not run a target if a file of the same name exists unless setting phony targets
+# https://www.gnu.org/software/make/manual/html_node/Phony-Targets.html
+.PHONY: default tarball image regenerate

plugins/base64/bin/komand_base64

@@ -0,0 +1,48 @@
+#!/usr/bin/env python
+# GENERATED BY INSIGHT-PLUGIN - DO NOT EDIT
+import os
+import json
+from sys import argv
+
+Name = "Base64"
+Vendor = "rapid7"
+Version = "1.1.6"
+Description = "Encode and decode data using the base64 alphabet"
+
+
+def main():
+    if 'http' in argv:
+        if os.environ.get("GUNICORN_CONFIG_FILE"):
+            with open(os.environ.get("GUNICORN_CONFIG_FILE")) as gf:
+                gunicorn_cfg = json.load(gf)
+                if gunicorn_cfg.get("worker_class", "sync") == "gevent":
+                    from gevent import monkey
+                    monkey.patch_all()
+        elif 'gevent' in argv:
+            from gevent import monkey
+            monkey.patch_all()
+
+    import insightconnect_plugin_runtime
+    from komand_base64 import connection, actions, triggers, tasks
+
+    class ICONBase64(insightconnect_plugin_runtime.Plugin):
+        def __init__(self):
+            super(self.__class__, self).__init__(
+                name=Name,
+                vendor=Vendor,
+                version=Version,
+                description=Description,
+                connection=connection.Connection()
+            )
+            self.add_action(actions.Encode())
+        
+            self.add_action(actions.Decode())
+        
+
+    """Run plugin"""
+    cli = insightconnect_plugin_runtime.CLI(ICONBase64())
+    cli.run()
+
+
+if __name__ == "__main__":
+    main()

plugins/base64/help.md

@@ -0,0 +1,117 @@
+# Description
+
+Encode and decode data using the base64 alphabet
+
+# Key Features
+  
+*This plugin does not contain any key features.*
+
+# Requirements
+  
+*This plugin does not contain any requirements.*
+
+# Supported Product Versions
+  
+*This plugin does not contain any supported product versions.*
+
+# Documentation
+
+## Setup
+  
+*This plugin does not contain a connection.*
+
+## Technical Details
+
+### Actions
+
+
+#### Decoder
+  
+Decode Base64 to data
+
+##### Input
+
+|Name|Type|Default|Required|Description|Enum|Example|
+| :--- | :--- | :--- | :--- | :--- | :--- | :--- |
+|base64|bytes|None|True|Data to decode|None|UmFwaWQ3IEluc2lnaHRDb25uZWN0Cgo=|
+|errors|string|nothing|False|How errors should be handled when decoding Base64|['replace', 'ignore', 'nothing']|ignore|
+  
+Example input:
+
+```
+{
+  "base64": "UmFwaWQ3IEluc2lnaHRDb25uZWN0Cgo=",
+  "errors": "nothing"
+}
+```
+
+##### Output
+
+|Name|Type|Required|Description|Example|
+| :--- | :--- | :--- | :--- | :--- |
+|data|string|True|Decoded data result|None|
+  
+Example output:
+
+```
+{
+  "data": ""
+}
+```
+
+#### Encoder
+  
+Encode data to Base64
+
+##### Input
+
+|Name|Type|Default|Required|Description|Enum|Example|
+| :--- | :--- | :--- | :--- | :--- | :--- | :--- |
+|content|string|None|True|Data to encode|None|Rapid7 InsightConnect|
+  
+Example input:
+
+```
+{
+  "content": "Rapid7 InsightConnect"
+}
+```
+
+##### Output
+
+|Name|Type|Required|Description|Example|
+| :--- | :--- | :--- | :--- | :--- |
+|data|bytes|True|Encoded data result|None|
+  
+Example output:
+
+```
+{
+  "data": ""
+}
+```
+### Triggers
+  
+*This plugin does not contain any triggers.*
+### Tasks
+  
+*This plugin does not contain any tasks.*
+
+### Custom Types
+  
+*This plugin does not contain any custom output types.*
+
+## Troubleshooting
+  
+*There is no troubleshooting for this plugin.*
+
+# Version History
+  
+*This plugin does not contain a version history.*
+
+# Links
+
+
+## References
+  
+*This plugin does not contain any references.*

plugins/base64/komand_base64/__init__.py

@@ -0,0 +1 @@
+# GENERATED BY INSIGHT-PLUGIN - DO NOT EDIT

plugins/base64/komand_base64/actions/__init__.py

@@ -0,0 +1,6 @@
+# GENERATED BY INSIGHT-PLUGIN - DO NOT EDIT
+
+from .encode.action import Encode
+
+from .decode.action import Decode
+

plugins/base64/komand_base64/actions/decode/__init__.py

@@ -0,0 +1,2 @@
+# GENERATED BY INSIGHT-PLUGIN - DO NOT EDIT
+from .action import Decode