Skip to main content

Verify secret_scanning_push_protection Setting

Type: Rule
ID: github-org-push-protection-sa
Source: v2/rules/github/org/push-protection-sa.yaml
Rego Source: push-protection-sa.rego
Labels: GitHub, Organization

Verify secret scanning push protection is configured in the GitHub repository.

note

This rule requires Github Organization 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. Without one, it will be disabled unless the --all-evidence flag is provided.

Usage example

uses: github/org/push-protection-sa@v2

Mitigation

Ensure that secret scanning push protection is enabled to provide better security for secret scanning in the GitHub organization.

Description

This rule ensures that secret scanning push protection is enabled in the security and analysis settings of the GitHub organization. It performs the following steps:

  1. Checks the security and analysis settings of the GitHub organization.
  2. Verifies that the secret scanning push protection setting is enabled.

Evidence Requirements:

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

Evidence Requirements

FieldValue
signedFalse
content_body_typegeneric
target_typedata
predicate_typehttp://scribesecurity.com/evidence/discovery/v0.1
labels- platform=github
- asset_type=organization