crickets-and-comb / crickets-and-comb/comb_utils
Set least privileges in workflow call block permissions.
- Dominant language
- Python
- Stars
- 1
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
Wherever we call one reusable workflow from another workflow, we should set the permissions to the least necessary. For instance, when we call `crickets-and-comb/shared/.github/workflows/test_install.yml@main` from `CI_CD.yml`. We should do this in this repo and all others in Crickets and Comb.
From GitHub security scan report:
"""
If a GitHub Actions job or workflow has no explicit permissions set, then the repository permissions are used. Repositories created under organizations inherit the organization permissions. The organizations or repositories created before February 2023 have the default permissions set to read-write. Often these permissions do not adhere to the principle of least privilege and can be reduced to read-only, leaving the write permission only to a specific types as issues: write or pull-requests: write.
Add the permissions key to the job or the root of workflow (in this case it is applied to all jobs in the workflow that do not have their own permissions key) and assign the least privileges required to complete the task:
"""
```
name: "My workflow"
permissions:
contents: read
pull-requests: write
```
or
```
jobs:
my-job:
permissions:
contents: read
pull-requests: write
```
Contributor guide
Assessment
This issue has not been assessed yet.