Scanning Engine v2 - Module - FTP

Overview

Targeting

Configuration

Only the publicly-available configuration keys that can be set in a job's module invocations will be described below. Additional configuration keys may exist, but not be shown here because they are restricted to specific users or because they are permanently set as a static value. If no keys have (required) after their names then invocations of this module need not contain a config key.

Named Keys

connect-timeout

Timeout for each connection, in seconds.

• Type: float
• Default: 30.0

debug

Run module with a debugging configuration.

• Type: boolean

max-breadth

Maximum breadth of the directory tree to walk.

• Type: integer
• Default: 30

max-depth

Maximum depth of the directory tree to walk.

• Type: integer
• Default: 3

password

Password for login.

• Type: string
• Default: anonymous

ssl

Control SSL/TLS usage: implicit (control) or explicit (control + data).

• Type: boolean

user

Username for login.

• Type: string
• Default: anonymous

Schemas

The schema for the body object of all results generated with .task.module_name equal to ftp can be found here. The schema for results is available both in standalone and bundled form.

Examples

These are examples of the .body object for results with .task.module_name equal to ftp.

FreeBSD

This example was generated with the FreeBSD website.

{
  "anonymous": true,
  "user": "anonymous",
  "password": "anonymous@",
  "connected": true,
  "content": [
    {
      "type": "-",
      "name": "favicon.ico",
      "sticky": false,
      "rights": {
        "user": "rw",
        "group": "r",
        "other": "r"
      },
      "acl": false,
      "owner": "ftp",
      "group": "ftp",
      "size": 5430,
      "date": "2020-01-02T00:00:00.000Z"
    },
    {
      "type": "-",
      "name": "index.html",
      "sticky": false,
      "rights": {
        "user": "rw",
        "group": "r",
        "other": "r"
      },
      "acl": false,
      "owner": "ftp",
      "group": "ftp",
      "size": 661,
      "date": "2022-01-12T00:00:00.000Z"
    },
    {
      "type": "d",
      "name": "pub",
      "sticky": false,
      "rights": {
        "user": "rwx",
        "group": "rx",
        "other": "rx"
      },
      "acl": false,
      "owner": "ftp",
      "group": "ftp",
      "size": 3,
      "date": "2020-01-02T00:00:00.000Z",
      "content": [
        {
          "type": "d",
          "name": "FreeBSD",
          "sticky": false,
          "rights": {
            "user": "rwx",
            "group": "rx",
            "other": "rx"
          },
          "acl": false,
          "owner": "ftp",
          "group": "ftp",
          "size": 13,
          "date": "2023-10-23T16:31:00.000Z",
          "content": [
            {
              "type": "-",
              "name": "README.TXT",
              "sticky": false,
              "rights": {
                "user": "rw",
                "group": "r",
                "other": "r"
              },
              "acl": false,
              "owner": "ftp",
              "group": "ftp",
              "size": 4259,
              "date": "2015-05-07T00:00:00.000Z"
            },
            {
              "type": "-",
              "name": "TIMESTAMP",
              "sticky": false,
              "rights": {
                "user": "rw",
                "group": "r",
                "other": "r"
              },
              "acl": false,
              "owner": "ftp",
              "group": "ftp",
              "size": 35,
              "date": "2023-10-23T16:30:00.000Z"
            },
            {
              "type": "d",
              "name": "development",
              "sticky": false,
              "rights": {
                "user": "rwx",
                "group": "rx",
                "other": "rx"
              },
              "acl": false,
              "owner": "ftp",
              "group": "ftp",
              "size": 10,
              "date": "2023-10-23T16:30:00.000Z"
            },
            {
              "type": "-",
              "name": "dir.sizes",
              "sticky": false,
              "rights": {
                "user": "rw",
                "group": "r",
                "other": "r"
              },
              "acl": false,
              "owner": "ftp",
              "group": "ftp",
              "size": 3003,
              "date": "2023-10-23T10:00:00.000Z"
            },
            {
              "type": "d",
              "name": "doc",
              "sticky": false,
              "rights": {
                "user": "rwx",
                "group": "rx",
                "other": "rx"
              },
              "acl": false,
              "owner": "ftp",
              "group": "ftp",
              "size": 28,
              "date": "2023-10-16T23:04:00.000Z"
            },
            {
              "type": "d",
              "name": "ports",
              "sticky": false,
              "rights": {
                "user": "rwx",
                "group": "rx",
                "other": "rx"
              },
              "acl": false,
              "owner": "ftp",
              "group": "ftp",
              "size": 6,
              "date": "2022-01-10T00:00:00.000Z"
            },
            {
              "type": "d",
              "name": "releases",
              "sticky": false,
              "rights": {
                "user": "rwx",
                "group": "rx",
                "other": "rx"
              },
              "acl": false,
              "owner": "ftp",
              "group": "ftp",
              "size": 14,
              "date": "2023-10-23T16:31:00.000Z"
            },
            {
              "type": "d",
              "name": "snapshots",
              "sticky": false,
              "rights": {
                "user": "rwx",
                "group": "rx",
                "other": "rx"
              },
              "acl": false,
              "owner": "ftp",
              "group": "ftp",
              "size": 13,
              "date": "2023-08-30T19:13:00.000Z"
            }
          ]
        }
      ]
    }
  ]
}

Changelog

• 2025-05-05: Initial release of versioning to each module. All modules are tagged with a version number "1.0.0". Going forward:
  • Major version should be changed when there are changes that impact consumers or clients of the modules
  • Minor version should be changed when there are additions which enrich or enhance the module but shouldn’t affect consumers or clients
  • Patch version should be changed when there are bugfixes