Verify Branch Verification Setting
Type: Rule
ID: github-repo-branch-verification
Source: v2/rules/github/repository/branch-verification.yaml
Rego Source: branch-verification.rego
Labels: GitHub, Repository
Verify branch verification in the GitHub repository matches the value defined in the configuration file.
This rule requires Github Repository Discovery Evidence. See here for more details.
Signed Evidence for this rule IS NOT required by default but is recommended.
Rule requires evaluation with a target. Without one, it will be disabled unless the --all-evidence flag is provided.
Usage example
uses: github/repository/branch-verification@v2
Mitigation
Ensures that branch verification settings are correctly configured, reducing the risk of unauthorized changes.
Description
This rule ensures that branch verification in the GitHub repository matches the value defined in the configuration file. It performs the following steps:
- Checks the repository settings for branch verification.
- Verifies that the verification setting matches the expected value.
Evidence Requirements:
- Evidence must be provided by the Scribe Platform's CLI tool through scanning GitHub repository settings.
Evidence Requirements
| Field | Value |
|---|---|
| signed | False |
| content_body_type | generic |
| target_type | data |
| predicate_type | http://scribesecurity.com/evidence/discovery/v0.1 |
| labels | - platform=github - asset_type=repository |
Rule Parameters (with)
| Parameter | Default |
|---|---|
| desired_verified | True |