AWS Security Hub step configuration
You can scan your configurations and ingest the scan results from AWS Security Hub.
Important notes for running AWS Security Hub scans in STO
-
This integration supports session-based authentication with AWS. You can pass the token as a key-value pair in the Settings field.
-
You can utilize custom STO scan images and pipelines to run scans as a non-root user. For more details, refer Configure your pipeline to use STO images from private registry.
-
STO supports three different approaches for loading self-signed certificates. For more information, refer Run STO scans with custom SSL certificates.
The following topics contain useful information for setting up scanner integrations in STO:
AWS Security Hub step configuration
The default workflow is to add an AWS Security Hub step to a Build or Security stage and configure it as described below.
Scan
Scan Mode
- Extraction Configure the step to extract scan results from an external SaaS service and then ingest, normalize, and deduplicate the data.
- Ingestion Configure the step to read scan results from a data file and then ingest, normalize, and deduplicate the data.
Scan Configuration
The predefined configuration to use for the scan. All scan steps have at least one configuration.
Target
Type
- Instance Scan a running application.
- Configuration Scan your cloud environment by gathering configuration data via the cloud provider’s APIs.
Name
The identifier for the target, such as codebaseAlpha
or jsmith/myalphaservice
. Descriptive target names make it much easier to navigate your scan data in the STO UI.
It is good practice to specify a baseline for every target.
Variant
The identifier for the specific variant to scan. This is usually the branch name, image tag, or product version. Harness maintains a historical trend for each variant.
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:
spec:
sharedPaths:
- /shared/scan_results
Authentication
You should create Harness text secrets with your encrypted access ID and token and access them using the format <+secrets.getValue("my-secret")>
.
Access ID
The access ID for your AWS account.
Access Token
The access token for your AWS account.
Access Region
Your AWS region.
Log Level
The minimum severity of the messages you want to include in your scan logs. You can specify one of the following:
- DEBUG
- INFO
- WARNING
- ERROR
Fail on Severity
Every STO scan 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:
CRITICAL
HIGH
MEDIUM
LOW
INFO
NONE
— Do not fail on severity
The YAML definition looks like this: fail_on_severity : critical # | high | medium | low | info | none
Settings
You can use this to add environment variables to your scan environment. To enable session-based authentication with AWS, for example, you can pass AWS_SESSION_TOKEN
with a Harness text secret of your token.
Proxy settings
This step supports Harness Secure Connect if you're using Harness Cloud infrastructure. During the Secure Connect setup, the HTTPS_PROXY
and HTTP_PROXY
variables are automatically configured to route traffic through the secure tunnel. If there are specific addresses that you want to bypass the Secure Connect proxy, you can define those in the NO_PROXY
variable. This can be configured in the Settings of your step.
If you need to configure a different proxy (not using Secure Connect), you can manually set the HTTPS_PROXY
, HTTP_PROXY
, and NO_PROXY
variables in the Settings of your step.
Definitions of Proxy variables:
HTTPS_PROXY
: Specify the proxy server for HTTPS requests, examplehttps://sc.internal.harness.io:30000
HTTP_PROXY
: Specify the proxy server for HTTP requests, examplehttp://sc.internal.harness.io:30000
NO_PROXY
: Specify the domains as comma-separated values that should bypass the proxy. This allows you to exclude certain traffic from being routed through the proxy.