Skip to content

Token-Permissions issue #11

Description

@tiffehr

Error
Token-Permissions
score is 0: topLevel 'contents' permission set to 'write'
Remediation tip: Visit https://app.stepsecurity.io/secureworkflow.
Tick the 'Restrict permissions for GITHUB_TOKEN'
Untick other options
NOTE: If you want to resolve multiple issues at once, you can visit https://app.stepsecurity.io/securerepo instead.
Click Remediation section below for further remediation help

Remediation (click "Show more" below):

Set top-level permissions as read-all or contents: read as described in GitHub's [documentation](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions).

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.

To help determine the permissions needed for your workflows, you may use [StepSecurity's online tool](https://app.stepsecurity.io/secureworkflow/) by ticking the "Restrict permissions for GITHUB_TOKEN". You may also tick the "Pin actions to a full length commit SHA" to fix issues found by the Pinned-dependencies check.

Severity: High

Details:

Risk: High (vulnerable to malicious code additions)

This check determines whether the project's automated workflows tokens follow the

principle of least privilege. This is important because attackers may use a

compromised token with write access to, for example, push malicious code into the

project.

It is currently limited to repositories hosted on GitHub, and does not support

other source hosting repositories (i.e., Forges).

The highest score is awarded when the permissions definitions in each workflow's

yaml file are set as read-only at the

[top level](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions)

and the required write permissions are declared at the

[run-level](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idpermissions).

One point is reduced from the score if all jobs have their permissions defined but the top level permissions are not defined.

This configuration is secure, but there is a chance that when a new job is added to the workflow, its job permissions could be

left undefined because of human error.

Though a project's score won't be penalized, the check's details will include

warnings for more sensitive run-level permissions, listed below:

actions - May allow an attacker to steal GitHub secrets by approving to run an action that needs approval.

checks - May allow an attacker to remove pre-submit checks and introduce a bug.

contents - Allows an attacker to commit unreviewed code. However, points are not reduced if the job utilizes a recognized packaging action or command.

deployments - May allow an attacker to charge repo owner by triggering VM runs, and tiny chance an attacker can trigger a remote service with code they own if server accepts code/location variables unsanitized.

packages - Allows an attacker to publish packages. However, points are not reduced if the job utilizes a recognized packaging action or command.

security-events - May allow an attacker to read vulnerability reports before a patch is available. However, points are not reduced if the job utilizes a recognized action for uploading SARIF results.

statuses - May allow an attacker to change the result of pre-submit checks and get a PR merged.

This compromise makes it clear the maintainer has done what's possible to use those permissions safety,

but allows users to identify that the permissions are used.

The check cannot detect if the "read-only" GitHub permission setting is

enabled, as there is no API available.

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions