Skip to content

chore: restrict GitHub workflow permissions - future-proof#125

Merged
lorentey merged 1 commit into
apple:mainfrom
incertum:chore/workflow-permissions
Nov 18, 2025
Merged

chore: restrict GitHub workflow permissions - future-proof#125
lorentey merged 1 commit into
apple:mainfrom
incertum:chore/workflow-permissions

Conversation

@incertum

Copy link
Copy Markdown
Contributor

See swiftlang/github-workflows#167 for additional context

This approach aligns with security best practices, as detailed in the following documentation:

The default GITHUB_TOKEN permissions are defined at the repository level. This PR modifies the workflow-level overrides to conform to OpenSSF best practices -> defense in depth.

Allow me to quote OpenSSF:
https://github.com/ossf/scorecard/blob/main/docs/checks.md#token-permissions

The highest score is awarded when the permissions definitions in each workflow's yaml file are set as read-only at the top level and the required write permissions are declared at the run-level.”

Remediation steps

  • Set top-level permissions as read-all or contents: read as described in GitHub's documentation.
  • Set any required write permissions at the job-level. Only set the permissions required for that job; do not set permissions: write-all at the job level.

Compare to the LLVM project:

Top-level: contents read, e.g. https://github.com/swiftlang/llvm-project/blob/next/.github/workflows/build-ci-container-windows.yml#L3-L4 -> this makes it future-proof

Job-level: Allow write permissions as needed, e.g. https://github.com/swiftlang/llvm-project/blob/next/.github/workflows/build-ci-container-windows.yml#L53-L58

Signed-off-by: Melissa Kilby <mkilby@apple.com>
@incertum incertum requested a review from shahmishal October 27, 2025 22:10
@incertum

incertum commented Nov 6, 2025

Copy link
Copy Markdown
Contributor Author

@shahmishal may I kindly check in on the status of this PR? Thank you.

@lorentey lorentey merged commit 7136010 into apple:main Nov 18, 2025
26 checks passed
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.

2 participants