Verify secret_scanning setting

Type: Rule
ID: github-repo-secret-scanning
Source: v2/rules/github/repository/secret-scanning.yaml
Rego Source: secret-scanning.rego
Labels: GitHub, Repository

Verify secret_scanning is configured in the GitHub repository.

note

This rule requires Github Repository Discovery Evidence. See here for more details.

tip

Signed Evidence for this rule IS NOT required by default but is recommended.

warning

Rule requires evaluation with a target or an asset input. Without one, it will be disabled unless the --all-evidence flag is provided.

info

Rule is scoped by product and target.

Usage example

uses: github/repository/secret-scanning@v2

Mitigation

Ensures that Secret Scanning is configured, reducing the risk of leaking sensitive information.

Description

This rule ensures that the secret_scanning is configured in the GitHub repository. It performs the following steps:

1. Checks the repository settings for secret_scanning configuration.
2. Verifies that the configuration matches the expected settings.

Evidence Requirements:

• Evidence must be provided by the Scribe Platform's CLI tool through scanning GitHub repository settings.

Evidence Requirements

Field	Value
filter-by	['product', 'target']
signed	False
content_body_type	generic
target_type	data
predicate_type	http://scribesecurity.com/evidence/discovery/v0.1
asset_platform	github
asset_type	repo