ssh sdk prep (#3250) (#3258)

rmurray-r7 · web-flow · commit 8ac1ea8b300e · 2025-03-04T15:47:58.000Z
diff --git a/plugins/ssh/.CHECKSUM b/plugins/ssh/.CHECKSUM
@@ -1,7 +1,7 @@
 {
-	"spec": "9247db0545cd8d1474eabb488c08997c",
-	"manifest": "58de38307d29215935d4e06a1a0943c7",
-	"setup": "b0941213ed47967cbec2b3e8a68bf900",
+	"spec": "3562c6d84061cd5d7f1fb41d11f447f0",
+	"manifest": "00e46897a559bac59a27dee57b448468",
+	"setup": "5fac1a750187e4a7a3ee01491454a88c",
 	"schemas": [
 		{
 			"identifier": "run/schema.py",
diff --git a/plugins/ssh/Dockerfile b/plugins/ssh/Dockerfile
@@ -1,4 +1,4 @@
-FROM --platform=linux/amd64 rapid7/insightconnect-python-3-slim-plugin:6.2.3
+FROM --platform=linux/amd64 rapid7/insightconnect-python-3-slim-plugin:6.2.5
 
 LABEL organization=rapid7
 LABEL sdk=python
diff --git a/plugins/ssh/bin/komand_ssh b/plugins/ssh/bin/komand_ssh
@@ -6,7 +6,7 @@ from sys import argv
 
 Name = "SSH"
 Vendor = "rapid7"
-Version = "4.0.3"
+Version = "4.0.4"
 Description = "[Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) (SSH) is a cryptographic network protocol for operating network services securely over an unsecured network. This plugin uses the [paramiko](http://www.paramiko.org/) to connect to a remote host via the library. The SSH plugin allows you to run commands on a remote host"
 
 
diff --git a/plugins/ssh/help.md b/plugins/ssh/help.md
@@ -110,12 +110,12 @@ Example output:
 ## Troubleshooting
 
 * The `key` field in connection setup takes a base64 encoded RSA private key which must contain a newline character after the BEGIN marker and before the END marker:
-E.g.
+ E.g.
 
 ```
 -----BEGIN RSA PRIVATE KEY-----
 MIIEogIBAAKCAQEA6NF8iallvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7g4h53s=
-...
+ ...
 -----END RSA PRIVATE KEY-----
 ```
 
@@ -124,6 +124,7 @@ This can then be pasted into the Connection's `key` input field
 
 # Version History
 
+* 4.0.4 - Updated SDK to the latest version (6.2.5)
 * 4.0.3 - Updated dependencies | Updated SDK to the latest version
 * 4.0.2 - Initial updates for fedramp compliance | Updated SDK to the latest version
 * 4.0.1 - Update from komand to insight-plugin-runtime
diff --git a/plugins/ssh/plugin.spec.yaml b/plugins/ssh/plugin.spec.yaml
@@ -3,57 +3,72 @@ extension: plugin
 products: [insightconnect]
 name: ssh
 title: SSH
-description: "[Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) (SSH) is a cryptographic network protocol for operating network services securely over an unsecured network. This plugin uses the [paramiko](http://www.paramiko.org/) to connect to a remote host via the library. The SSH plugin allows you to run commands on a remote host"
-version: 4.0.3
+description: '[Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) (SSH) is
+  a cryptographic network protocol for operating network services securely over an
+  unsecured network. This plugin uses the [paramiko](http://www.paramiko.org/) to
+  connect to a remote host via the library. The SSH plugin allows you to run commands
+  on a remote host'
+version: 4.0.4
 connection_version: 4
-supported_versions: ["SSH 2025-01-15"]
+supported_versions: [SSH 2025-01-15]
 vendor: rapid7
 support: community
 status: []
 resources:
   source_url: https://github.com/rapid7/insightconnect-plugins/tree/master/plugins/ssh
   license_url: https://github.com/rapid7/insightconnect-plugins/blob/master/LICENSE
 tags:
-  - ssh
-  - remote
-  - tunnel
+- ssh
+- remote
+- tunnel
 hub_tags:
   use_cases: [threat_detection_and_response]
   keywords: [ssh]
   features: []
 fedramp_ready: true
 sdk:
   type: slim
-  version: 6.2.3
+  version: 6.2.5
   user: nobody
 key_features:
-  - Run remote commands with SSH
+- Run remote commands with SSH
 requirements:
-  - Credentials for the target remote host
-  - Address and port for the target remote host
+- Credentials for the target remote host
+- Address and port for the target remote host
 troubleshooting:
-  - "The `key` field in connection setup takes a base64 encoded RSA private key which must contain a newline character after the BEGIN marker and before the END marker:\nE.g.\n\n```\n-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEA6NF8iallvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7g4h53s=\n...\n-----END RSA PRIVATE KEY-----\n```\n\nYou can easily encode a private key file and copy a key to your clipboard on MacOS with the following command: `base64 < .ssh/id_rsa | pbcopy`.\nThis can then be pasted into the Connection's `key` input field"
+- "The `key` field in connection setup takes a base64 encoded RSA private key which
+  must contain a newline character after the BEGIN marker and before the END marker:\n
+  E.g.\n\n```\n-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEA6NF8iallvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7g4h53s=\n
+  ...\n-----END RSA PRIVATE KEY-----\n```\n\nYou can easily encode a private key file
+  and copy a key to your clipboard on MacOS with the following command: `base64 <
+  .ssh/id_rsa | pbcopy`.\nThis can then be pasted into the Connection's `key` input
+  field"
 version_history:
-  - "4.0.3 - Updated dependencies | Updated SDK to the latest version"
-  - "4.0.2 - Initial updates for fedramp compliance | Updated SDK to the latest version"
-  - "4.0.1 - Update from komand to insight-plugin-runtime"
-  - "4.0.0 - Upgrade the plugin runtime to `komand/python-3-37-plugin` and run as least-privileged user | Change the SSH key credential type to `credential_secret_key` to skip PEM validation in the product UI"
-  - "3.0.1 - Fixed issue obtaining username in connection"
-  - "3.0.0 - Update connection username from credential_secret_key to string"
-  - "2.0.0 - Update Run action output to return 3 output fields i.e. `stderr`, `stdout`, and `all_output`"
-  - "1.0.3 - New spec and help.md format for the Extension Library"
-  - "1.0.2 - Fixed issue where Run was excluded"
-  - "1.0.1 - Fix issue where run action was excluded from plugin on build"
-  - '1.0.0 - Support web server mode | Update to new credential types | Rename "Run remote command" action to "Run Remote Command"'
-  - "0.1.3 - SSL bug fix in SDK"
-  - "0.1.2 - Strip extra newlines in key"
-  - "0.1.1 - Connection SSH key input is now type bytes"
-  - "0.1.0 - Initial plugin"
+- 4.0.4 - Updated SDK to the latest version (6.2.5)
+- 4.0.3 - Updated dependencies | Updated SDK to the latest version
+- 4.0.2 - Initial updates for fedramp compliance | Updated SDK to the latest version
+- 4.0.1 - Update from komand to insight-plugin-runtime
+- 4.0.0 - Upgrade the plugin runtime to `komand/python-3-37-plugin` and run as least-privileged
+  user | Change the SSH key credential type to `credential_secret_key` to skip PEM
+  validation in the product UI
+- 3.0.1 - Fixed issue obtaining username in connection
+- 3.0.0 - Update connection username from credential_secret_key to string
+- 2.0.0 - Update Run action output to return 3 output fields i.e. `stderr`, `stdout`,
+  and `all_output`
+- 1.0.3 - New spec and help.md format for the Extension Library
+- 1.0.2 - Fixed issue where Run was excluded
+- 1.0.1 - Fix issue where run action was excluded from plugin on build
+- 1.0.0 - Support web server mode | Update to new credential types | Rename "Run remote
+  command" action to "Run Remote Command"
+- 0.1.3 - SSL bug fix in SDK
+- 0.1.2 - Strip extra newlines in key
+- 0.1.1 - Connection SSH key input is now type bytes
+- 0.1.0 - Initial plugin
 links:
-  - "[Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell)"
+- '[Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell)'
 references:
-  - "[OpenSSH](https://www.openssh.com/)"
-  - "[paramiko](https://www.paramiko.org/)"
+- '[OpenSSH](https://www.openssh.com/)'
+- '[paramiko](https://www.paramiko.org/)'
 types:
   results:
     stdout:
diff --git a/plugins/ssh/setup.py b/plugins/ssh/setup.py
@@ -3,7 +3,7 @@
 
 
 setup(name="ssh-rapid7-plugin",
-      version="4.0.3",
+      version="4.0.4",
       description="[Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) (SSH) is a cryptographic network protocol for operating network services securely over an unsecured network. This plugin uses the [paramiko](http://www.paramiko.org/) to connect to a remote host via the library. The SSH plugin allows you to run commands on a remote host",
       author="rapid7",
       author_email="",

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`		`- "spec": "9247db0545cd8d1474eabb488c08997c",`
`3`		`- "manifest": "58de38307d29215935d4e06a1a0943c7",`
`4`		`- "setup": "b0941213ed47967cbec2b3e8a68bf900",`
	`2`	`+ "spec": "3562c6d84061cd5d7f1fb41d11f447f0",`
	`3`	`+ "manifest": "00e46897a559bac59a27dee57b448468",`
	`4`	`+ "setup": "5fac1a750187e4a7a3ee01491454a88c",`
`5`	`5`	`"schemas": [`
`6`	`6`	`{`
`7`	`7`	`"identifier": "run/schema.py",`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-FROM --platform=linux/amd64 rapid7/insightconnect-python-3-slim-plugin:6.2.3`
	`1`	`+FROM --platform=linux/amd64 rapid7/insightconnect-python-3-slim-plugin:6.2.5`
`2`	`2`
`3`	`3`	`LABEL organization=rapid7`
`4`	`4`	`LABEL sdk=python`