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.

Sign up for GitHub

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

docs: add support for pull_request_target events #32

Merged
merged 5 commits into from
Dec 5, 2023
Merged

docs: add support for pull_request_target events #32

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
67ba360
docs: add support for `pull_request_target` events
maxrake Oct 25, 2023
0130f85
Merge branch 'main' into gh_pr_target
maxrake Nov 16, 2023
17db89a
docs: PR suggestions and update marketplace description
maxrake Dec 4, 2023
d1ada28
docs: add FAQs section to README
maxrake Dec 5, 2023
c856197
docs: apply PR suggestion
maxrake Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 66 additions & 6 deletions README.md
View file
Open in desktop
maxrake marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
![GitHub last commit](https://img.shields.io/github/last-commit/phylum-dev/phylum-analyze-pr-action)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)][CoC]

A GitHub Action using Phylum to automatically analyze Pull Requests for changes to package manager dependency files.
A GitHub Action to analyze dependencies with Phylum to protect your code against increasingly sophisticated attacks and get peace of mind to focus on your work.

[license]: https://github.com/phylum-dev/phylum-analyze-pr-action/blob/main/LICENSE
[issues]: https://github.com/phylum-dev/phylum-analyze-pr-action/issues
Expand Down Expand Up @@ -45,6 +45,7 @@ The pre-requisites for using this image are:
* [Contact Phylum][phylum_contact] or [register][app_register] to gain access
* See also [`phylum auth register`][phylum_register] command documentation
* Consider using a bot or group account for this token
* Forked repos require the `pull_request_target` event, to allow secret access
* Access to the Phylum API endpoints
* That usually means a connection to the internet, optionally via a proxy
* Support for on-premises installs are not available at this time
Expand Down Expand Up @@ -84,7 +85,7 @@ information on [lockfile generation][lockfile_generation] can be found for curre

## Getting Started

Phylum analysis of dependencies can be added to existing CI workflows or on it's own with this minimal configuration:
Phylum analysis of dependencies can be added to existing CI workflows or on its own with this minimal configuration:

```yaml
name: Phylum_analyze
Expand Down Expand Up @@ -150,6 +151,36 @@ on:
- develop
```

Allowing pull requests from forked repositories requires using the `pull_request_target` event since the Phylum API
key is stored as a secret and the `pull_request` event does not provide access to secrets when the PR comes from a
fork.

```yaml
on:
pull_request:
# Allow PRs from forked repos to access secrets, like the Phylum API key
pull_request_target:
```

> ⚠️ **WARNING** ⚠️
>
> Using the `pull_request_target` event for forked repositories requires additional configuration when
> [checking out the repo](#checking-out-the-repository). Be aware that such a configuration has security implications
> if done improperly. Attackers may be able to obtain repository write permissions or steal repository secrets.
> Please take the time to understand and mitigate the risks:
>
> * GitHub Security Lab: ["Preventing pwn requests"][gh_pwn]
> * GitGuardian: ["GitHub Actions Security Best Practices"][gha_security]
>
> Minimal suggestions include:
>
> * Use a separate workflow for the Phylum Analyze PR action
> * Do not provide access to any secrets beyond the Phylum API key
> * Limit the steps in the job to two: checking out the PR's code and using the Phylum action

[gh_pwn]: https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
[gha_security]: https://blog.gitguardian.com/github-actions-security-cheat-sheet/

### Permissions

When using the default `GITHUB_TOKEN` provided automatically at the start of each workflow run, it is good practice to
Expand Down Expand Up @@ -203,9 +234,38 @@ the local working copy is always pristine and history is available to pull the r
fetch-depth: 0
```

Allowing pull requests from forked repositories [requires using the `pull_request_target` event](#workflow-trigger)
and checking out the head of the forked repository:

```yaml
steps:
- name: Checkout the repo
uses: actions/checkout@v4
with:
fetch-depth: 0
# Specifying the head of the forked repository's PR branch
# is required to get any proposed dependency file changes.
ref: ${{ github.event.pull_request.head.sha }}
```

> ⚠️ **WARNING** ⚠️
>
> Using the `pull_request_target` event for forked repositories and checking out the pull request's code has security
maxrake marked this conversation as resolved.
Show resolved Hide resolved
> implications if done improperly. Attackers may be able to obtain repository write permissions or steal repository
> secrets. Please take the time to understand and mitigate the risks:
>
> * GitHub Security Lab: ["Preventing pwn requests"][gh_pwn]
> * GitGuardian: ["GitHub Actions Security Best Practices"][gha_security]
>
> Minimal suggestions include:
>
> * Use a separate workflow for the Phylum Analyze PR action
> * Do not provide access to any secrets beyond the Phylum API key
> * Limit the steps in the job to two: checking out the PR's code and using the Phylum action

### Action Inputs

The action inputs are used to ensure the `phylum-ci` tool is able to perform it's job.
The action inputs are used to ensure the `phylum-ci` tool is able to perform its job.

A [Phylum token][phylum_tokens] with API access is required to perform analysis on project dependencies.
[Contact Phylum][phylum_contact] or [register][app_register] to gain access.
Expand Down Expand Up @@ -280,15 +340,15 @@ view the [script options output][script_options] for the latest release.
# and committing the generated `.phylum_project` file.
cmd: phylum-ci --lockfile requirements-prod.txt
# Specify multiple explicit dependency file paths
cmd: phylum-ci --lockfile requirements-prod.txt path/to/lock.file
cmd: phylum-ci --lockfile requirements-prod.txt path/to/dependency.file
# Install a specific version of the Phylum CLI.
cmd: phylum-ci --phylum-release 4.8.0 --force-install
# Mix and match for your specific use case.
cmd: |
phylum-ci \
-vv \
--lockfile requirements-dev.txt \
--lockfile requirements-prod.txt path/to/lock.file \
--lockfile requirements-prod.txt path/to/dependency.file \
--lockfile Cargo.toml \
--force-analysis \
--all-deps
Expand Down Expand Up @@ -329,7 +389,7 @@ installed version of the Phylum CLI and all required tools needed for [lockfile
An advantage of using the default Docker image is that the complete environment is packaged and made available with
components that are known to work together.

One disadvantage to the default image is it's size. It can take a while to download and may provide more tools than
One disadvantage to the default image is its size. It can take a while to download and may provide more tools than
required for your specific use case. Special `slim` tags of the `phylum-ci` image are provided as an alternative.
These tags differ from the default image in that they do not contain the required tools needed for
[lockfile generation][lockfile_generation] (with the exception of the `pip` tool). The `slim` tags are significantly
Expand Down
2 changes: 1 addition & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
---
name: Phylum Analyze PR
author: Phylum, Inc. <[email protected]>
description: Analyze dependencies in a pull request with Phylum
description: Scan dependencies with Phylum to block software supply chain attacks
branding:
icon: check-circle
color: blue
Expand Down