Verify Branch Protection Setting
Type: Rule
ID: github-repo-branch-protection
Source: v2/rules/github/repository/branch-protection.yaml
Rego Source: branch-protection.rego
Labels: GitHub, Repository
Verify branch protection is configured in the GitHub repository.
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 or an asset input. Without one, it will be disabled unless the --all-evidence flag is provided.
Rule is scoped by product and target.
Usage example
uses: github/repository/branch-protection@v2
with:
desired_protected: true
branches:
- 'main'
- 'master'
Mitigation
Ensure branch protection settings are correctly configured to reduce the risk of unauthorized changes.
Description
This rule ensures that branch protection is configured in the GitHub repository. It performs the following steps:
- Checks the repository settings for branch protection.
- Verifies that the protection settings match the expected values.
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 |
Input Definitions
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
| desired_protected | boolean | False | Desired branch protection setting. | True |
| branches | array | False | List of branches to be protected. | ['main', 'master'] |