Skip to main content

ScoutSuite scanner reference for STO

You can ingest configuration scan results from ScoutSuite.

For more information

The following topics contain useful information for setting up scanner integrations in STO:

Security step settings for ScoutSuite scans in STO

To ingest your results, add a Security step to a Build or Security Tests stage and configure it as described below.

Target and variant

The following settings are required for every Security step:

  • target_name A user-defined label for the code repository, container, application, or configuration to scan.
  • variant A user-defined label for the branch, tag, or other target variant to scan.

Make sure that you give unique, descriptive names for the target and variant. This makes navigating your scan results in the STO UI much easier.

You can see the target name, type, and variant in the Test Targets UI:

Target name, type, and branch

For more information, go to Targets, baselines, and variants in STO.

ScoutSuite scan settings

Configuration scan settings

The following settings apply to all scanners where the scan_type is configuration. You should create Harness text secrets with your encrypted access ID and token and access them using the format <+secrets.getValue("")>.

  • configuration_type
    • accepted value(s)s: aws_account
  • configuration_region
  • configuration_environment
  • configuration_access_id
  • configuration_access_token

Ingestion file

If the policy_type is ingestionOnly:

  • ingestion_file = The path to your scan results when running an Ingestion scan, for example /shared/scan_results/myscan.latest.sarif.
  • The data file must be in a supported format for the scanner.

  • The data file must be accessible to the scan step. It's good practice to save your results files to a shared path in your stage. In the visual editor, go to the stage where you're running the scan. Then go to Overview > Shared Paths. You can also add the path to the YAML stage definition like this:

        - stage:
    - /shared/scan_results

Fail on Severity

Every Security step has a Fail on Severity setting. If the scan finds any vulnerability with the specified severity level or higher, the pipeline fails automatically. You can specify one of the following:

  • HIGH
  • LOW
  • INFO
  • NONE — Do not fail on severity

The YAML definition looks like this: fail_on_severity : critical # | high | medium | low | info | none