Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: add minimum GitHub token permissions for workflow #1898

Merged

Conversation

ashishkurmi
Copy link
Contributor

Description

This PR adds minimum token permissions for the GITHUB_TOKEN in GitHub Actions workflows using secure-workflows.

The GitHub Actions workflow has a GITHUB_TOKEN with write access to multiple scopes. Here is an example of the permissions in one of the workflow runs:
https://github.com/mavlink/mavlink/actions/runs/3148604498/jobs/5119313621#step:1:19

After this change, the scopes will be reduced to the minimum needed for the following workflow:

  • test_and_deploy.yml

Motivation and Context

  • This is a security best practice, so if the GITHUB_TOKEN is compromised due to a vulnerability or compromised Action, the damage will be reduced.
  • GitHub recommends defining minimum GITHUB_TOKEN permissions.
  • The Open Source Security Foundation (OpenSSF) Scorecards also treats not setting token permissions as a high-risk issue. This change will help increase the Scorecard score for this repository.

Signed-off-by: Ashish Kurmi akurmi@stepsecurity.io

Signed-off-by: Ashish Kurmi <akurmi@stepsecurity.io>
@hamishwillee
Copy link
Collaborator

@julianoes Is this something we want to do? I don't understand whether this will stop deployment phase, and the risks of not accepting this.

@julianoes
Copy link
Collaborator

@hamishwillee I think this makes sense. I believe our deploy step will still work but we'll find out.

Thanks @boahc077 for the PR!

@julianoes julianoes merged commit af35d3a into mavlink:master Oct 9, 2022
@julianoes
Copy link
Collaborator

Push to https://github.com/mavlink/c_library_v2/ still works.

@hamishwillee
Copy link
Collaborator

Thank you @boahc077 and @julianoes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants