See the following sections for the configuration settings required by the Filesystem Scanner plugin.

  1. Required Configuration Fields:
    • hostAddress, port, username, password/privateKey, maxDepth
  2. Authentication Options:
    • Password-based (password field)
    • Key-based (privateKey field) - Recommended
    • Must provide exactly ONE, not both
  3. Test Configuration Flow:
    • First "test" call: Shows SSH host key fingerprint popup
    • User confirms: "Trust and Continue" or "Cancel"
    • Second "test" call: Validates credentials & scan paths

Configuration Examples

Example 1: Password Authentication

{
  "hostAddress": "10.1.127.33",
  "port": "22",
  "username": "admin",
  "password": "your-secure-password",
  "scanPaths": "/etc/ssl,/opt",
  "maxDepth": "8"
}

Example 2: SSH Key Authentication (Recommended)

{
  "hostAddress": "prod-server.example.com",
  "port": "2222",
  "username": "sysadmin",
  "privateKey": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQ...\n-----END PRIVATE KEY-----",
  "scanPaths": "/etc/ssl,/etc/pki,/opt,/var/lib",
  "maxDepth": "10"
}

Example 3: Multiple Custom Scan Paths

{
  "hostAddress": "app-server.local",
  "port": "22",
  "username": "security",
  "privateKey": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----",
  "scanPaths": "/opt/applications,/var/lib/tomcat,/home/appuser/.ssh",
  "maxDepth": "6"
}