Restrict minimum necessary permissions for GITHUB_TOKEN #70
Conversation
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
Restrict minimum necessary permissions for GITHUB_TOKEN.
By adding permissions: { contents: read } at the top level, the permission scope of GITHUB_TOKEN is restricted. It only retains the necessary permission to read repository content (used for the actions/checkout step to pull code). Authentication for deployment to PyPI is handled via secrets.PYPI, and no additional permissions from the GitHub token are required, which complies with the principle of least privilege.
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.
In GitHub Actions, GITHUB_TOKEN is an automatically generated token used to interact with the GitHub repository in workflows (e.g., pulling code, triggering other workflows). By default, it may have broad permissions, such as read and write access to repository content and the ability to manipulate pull requests.
Meanwhile, "restricting to the minimum necessary permissions" is a security best practice: only assign the permissions that are essential for the normal operation of the workflow to GITHUB_TOKEN (e.g., only allowing read access to repository content), and remove all unnecessary permissions (such as write or delete access). This approach helps reduce security risks in case the token is misused, and aligns with the Principle of Least Privilege.