Document least-privilege permissions in example workflow - #29
Merged
Conversation
The action authenticates via SSH and never uses GITHUB_TOKEN, so consuming
workflows can drop all token permissions. Add `permissions: {}` to the
example to model least privilege (see #23, OpenSSF Scorecards).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
permissions: {}to the example workflow in the README.This action authenticates via SSH (
SSH_PRIVATE_KEY/ deploy key) and never usesGITHUB_TOKEN, so consuming workflows need no token permissions. Settingpermissions: {}follows the least-privilege principle checked by OpenSSF Scorecards.Note:
{}applies to the whole job. Workflows that add other steps (e.g.actions/checkout) need to grant those steps their own scopes (e.g.contents: read); the example has no such step.Addresses #23.