configure-secret-scan
Add secret detection scanning steps to existing Harness pipelines using STO security scanners. Detects exposed credentials, API keys, tokens, and sensitive data in code repositories. Supports Harness Code (default, native, unified SAST/SCA/secret detection), Gitleaks (standalone secret scanner, open-source), Semgrep, Snyk, SonarQube, Checkmarx, Fossa, Aqua Trivy, and Wiz. Only works with existing pipelines that have a codebase connector configured. Use when asked to add secret scanning, detect exposed secrets, find leaked API keys, configure secret detection, or scan code for credentials. Trigger phrases: add secret scan, detect secrets, find leaked credentials, configure secret detection, scan for exposed API keys, add Gitleaks, secret scanning pipeline.
harness · 已有 AI 审核记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add harness/harness-skills --skill configure-secret-scan技能说明
name: configure-secret-scan description: >- Add secret detection scanning steps to existing Harness pipelines using STO security scanners. Detects exposed credentials, API keys, tokens, and sensitive data in code repositories. Supports Harness Code (default, native, unified SAST/SCA/secret detection), Gitleaks (standalone secret scanner, open-source), Semgrep, Snyk, SonarQube, Checkmarx, Fossa, Aqua Trivy, and Wiz. Only works with existing pipelines that have a codebase connector configured. Use when asked to add secret scanning, detect exposed secrets, find leaked API keys, configure secret detection, or scan code for credentials. Trigger phrases: add secret scan, detect secrets, find leaked credentials, configure secret detection, scan for exposed API keys, add Gitleaks, secret scanning pipeline. metadata: author: Harness version: 1.0.0 mcp-server: harness-mcp-v2 license: Apache-2.0 compatibility: Requires Harness MCP v2 server (harness-mcp-v2)
Configure Secret Scan
Add secret detection scanning steps to existing Harness pipelines using Harness STO. Scans code repositories for exposed credentials, API keys, tokens, and other sensitive information.
Instructions
Step 1: Establish Scope and Pipeline Context
Ask the user for the organization, project, and pipeline identifier if not already known. This skill only works with existing pipelines.
Call MCP tool: harness_get
Parameters:
resource_type: "pipeline"
resource_id: "<pipeline_identifier>"
org_id: "<organization>"
project_id: "<project>"
Step 2: Extract Repository Connector from Pipeline
Parse the pipeline YAML to automatically identify the repository connector.
- For v0 pipelines: Check
pipeline.properties.ci.codebase.connectorRef - For v1 pipelines: Check the codebase connector in the pipeline configuration
If no connector is found, inform the user the pipeline has no codebase configuration and cannot proceed with secret scanning.
Step 3: Analyze Pipeline Structure
Parse the pipeline YAML to identify all stages, steps, and any existing secret scanning steps.
Present the structure to the user:
Pipeline: <name>
Stage 1: <stage_name> (type: <stage_type>)
- Step 1: <step_name> (type: <step_type>)
...
Ask where to insert the secret scan step — before or after which step, or at the end of which stage. Recommend adding it early in the CI stage, before build steps, so secrets are caught before any artifacts are produced.
Step 4: Recommend Scanner Type
Present the available secret detection scanners supported in Harness STO:
Top recommendation:
- Harness Code (default — native Harness scanner, zero config, integrated SAST + SCA + secret detection in a single step)
Dedicated standalone secret scanner:
- Gitleaks (recommended if user wants a dedicated secret-only scanner — open-source, no paid license, built-in scanner available)
Other scanners that also detect secrets as a side effect (findings appear under the "Secret" issue type alongside SAST/SCA results):
- Aqua Trivy (open-source)
- Checkmarx (commercial)
- Checkmarx One (commercial)
- Fossa (commercial)
- Semgrep (open-source core / commercial)
- Snyk (commercial)
- SonarQube (commercial)
- Wiz (commercial)
Default recommendation: Use Harness Code — the native Harness scanner that provides unified SAST, SCA, and secret detection with zero configuration and seamless STO integration. If the user explicitly wants a dedicated secret-only scanner, recommend Gitleaks as the standalone option.
Ask the user which scanner they prefer. If they don't specify, use Harness Code as the default.
Scanner product auth requirements:
| Scanner | type field | Product auth needed? | Auth fields |
|---|---|---|---|
| Gitleaks | Gitleaks | No | — |
| Harness Code | HarnessSAST | No | — |
| Aqua Trivy | AquaTrivy | No | — |
| Semgrep (OSS) | Semgrep | No | — |
| Semgrep (commercial) | Semgrep | Yes | access_token (Semgrep API token) |
| Snyk | Snyk | Yes | access_token (Snyk API token) |
| SonarQube | SonarQube | Yes | access_id (host URL), access_token (user token) |
| Checkmarx | Checkmarx | Yes | access_id (username), access_token (password) |
| Checkmarx One | CheckmarxOne | Yes | access_id (client ID), access_token (client secret) |
| Fossa | Fossa | Yes | access_token (FOSSA API key) |
| Wiz | Wiz | Yes | access_id (client ID), access_token (client secret) |
If the user picks a commercial scanner:
- Inform the user that scanner product credentials are required
- Ask for the secret references from the table above — secrets must already exist in Harness
- Format as
<+secrets.getValue("project.<secret_identifier>")> - If secrets don't exist, prompt the user to create them via
/create-secretfirst
Step 5: Generate Scanner Step Configuration
For Harness Code (default — unified SAST + SCA + secret detection):
- step:
type: HarnessSAST
name: Harness_Code_Scan
identifier: Harness_Code_Scan
spec:
mode: orchestration
config: sast_sca
target:
type: repository
detection: auto
advanced:
log:
level: info
For Gitleaks (standalone secret scanner — Built-in):
- step:
type: Gitleaks
name: Gitleaks_Secret_Scan
identifier: Gitleaks_Secret_Scan
spec:
mode: orchestration
config: default
target:
type: repository
detection: auto
advanced:
log:
level: info
For Semgrep (OSS, no auth):
- step:
type: Semgrep
name: Semgrep_Secret_Scan
identifier: Semgrep_Secret_Scan
spec:
mode: orchestration
config: default
target:
type: repository
detection: auto
advanced:
log:
level: info
**For commercial scanners — add auth