Add cargo-vet and cargo-deny supply-chain security#27
Open
jerrysxie wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces supply-chain security tooling for the crate, adding cargo-vet (with upstream audit imports) and cargo-deny (policy checks) plus CI automation to enforce them.
Changes:
- Add
cargo-vetconfiguration undersupply-chain/(local audits file, import config, imports lock). - Add GitHub Actions workflows to run
cargo veton PRs and (on failure/success transitions) comment on the PR. - Add
cargo-denyconfiguration (deny.toml) and runcargo deny checkin the main CI workflow.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| supply-chain/imports.lock | Initializes cargo-vet imports lock for external audit sources. |
| supply-chain/config.toml | Declares cargo-vet version and audit import URLs (ODP/Google/Mozilla). |
| supply-chain/audits.toml | Adds local cargo-vet audits file scaffold. |
| .github/workflows/cargo-vet.yml | Runs cargo vet in CI for pull requests. |
| .github/workflows/cargo-vet-pr-comment.yml | Posts/updates PR comments based on cargo-vet results via workflow_run. |
| .github/workflows/check.yml | Adds a cargo-deny job to CI checks. |
| deny.toml | Defines cargo-deny policy for advisories/licenses/bans/sources. |
Comments suppressed due to low confidence (1)
.github/workflows/cargo-vet-pr-comment.yml:44
echo "pr_number=$(cat ./pr/NR)" >> $GITHUB_OUTPUTwrites attacker-controlled file contents into the GITHUB_OUTPUT command file (newlines can inject additional outputs). If you keep reading from a file, sanitize/validate it as a numeric PR number and use the multiline-safe output format; ideally remove this entirely by using the PR number from theworkflow_runevent payload.
- name: 'Get PR number'
id: get-pr-number
run: echo "pr_number=$(cat ./pr/NR)" >> $GITHUB_OUTPUT
Comment on lines
+26
to
+49
| # It will download the artifact from the failed job and post a comment on the PR | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| comment-id: ${{ steps.get-comment-id.outputs.comment-id }} | ||
| pr-number: ${{ steps.get-pr-number.outputs.pr_number }} | ||
| if: github.event.workflow_run.event == 'pull_request' | ||
| steps: | ||
| - name: 'Download artifact' | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| name: pr | ||
| path: pr/ | ||
| run-id: ${{ github.event.workflow_run.id }} | ||
|
|
||
| - name: 'Get PR number' | ||
| id: get-pr-number | ||
| run: echo "pr_number=$(cat ./pr/NR)" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: 'Find existing comment' | ||
| id: find-comment | ||
| uses: peter-evans/find-comment@v3 | ||
| with: | ||
| issue-number: ${{ steps.get-pr-number.outputs.pr_number }} |
| # Cargo Vet Audit Failed | ||
|
|
||
| `cargo vet` has failed in this PR. Please run `cargo vet --locked` locally to check for new or updated unvetted dependencies. | ||
| Details about the vetting process can be found in [supply-chain/README.md](../blob/main/supply-chain/README.md) |
| pull-requests: write | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} |
Comment on lines
+43
to
+49
| if: ${{ failure() }} || ${{ success() }} | ||
| run: | | ||
| mkdir -p ./pr | ||
| echo ${{ github.event.number }} > ./pr/NR | ||
| - uses: actions/upload-artifact@v4 | ||
| # Need to upload the artifact in both success and failure cases so comment can be updated in either case | ||
| if: ${{ failure() }} || ${{ success() }} |
Comment on lines
+22
to
+53
| - uses: actions/checkout@v4 | ||
| with: | ||
| submodules: true | ||
|
|
||
| - uses: actions/cache@v4 | ||
| with: | ||
| path: ${{ runner.tool_cache }}/cargo-vet | ||
| key: cargo-vet-bin-${{ env.CARGO_VET_VERSION }} | ||
|
|
||
| - name: Add the tool cache directory to the search path | ||
| run: echo "${{ runner.tool_cache }}/cargo-vet/bin" >> $GITHUB_PATH | ||
|
|
||
| - name: Ensure that the tool cache is populated with the cargo-vet binary | ||
| run: cargo install --root ${{ runner.tool_cache }}/cargo-vet --version ${{ env.CARGO_VET_VERSION }} cargo-vet | ||
|
|
||
| - name: Invoke cargo-vet | ||
| run: cargo vet --locked | ||
|
|
||
| - name: Save PR number | ||
| # PR number is saved as an artifact so it can be used to determine the PR to comment on by the vet-pr-comment workflow | ||
| # vet-pr-comment workflow is triggered by the workflow_run event so it runs in the context of the base branch and not the PR branch | ||
| if: ${{ failure() }} || ${{ success() }} | ||
| run: | | ||
| mkdir -p ./pr | ||
| echo ${{ github.event.number }} > ./pr/NR | ||
| - uses: actions/upload-artifact@v4 | ||
| # Need to upload the artifact in both success and failure cases so comment can be updated in either case | ||
| if: ${{ failure() }} || ${{ success() }} | ||
| with: | ||
| name: pr | ||
| path: pr/ | ||
| overwrite: true |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds supply-chain security tooling based on the
embedded-rust-template:
supply-chain/) – dependency audit tracking with importsfrom ODP shared audits, Google, and Mozilla.
deny.toml) – license, advisory, ban, and source checks.cargo-vet.yml+ PR comment workflow, and thedenyjob incheck.yml.After merging, run
cargo vetlocally to populate exemptions for anyexisting unaudited dependencies: