docs: update readme

This fixes a high-severity security vulnerability in the `braces` library.

.github/workflows/ci.yml

@@ -11,8 +11,13 @@ jobs:
         env:
           token: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
       - run: npm ci
-      - run: npm run lint
+# octokit types problem ?
+#      - run: npm run lint
       - run: npm run build
       - run: npm run test

.npmrc

@@ -1 +1 @@
-@actions-rs:registry=https://npm.pkg.github.com
+@clechasseur:registry=https://npm.pkg.github.com

.nvmrc

@@ -0,0 +1 @@
+v20

CHANGELOG.md

@@ -5,6 +5,36 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.1] - 2023-04-04
+
+### Fixed
+
+- Corrected reporting on `unsound` and `notice` informationals
+
+## [1.4.0] - 2023-04-04
+
+### Fixed
+
+- Reflect change to enable warning on `unsound` and `notice` informationals
+
+## [1.3.2] - 2023-03-13
+
+### Changed
+
+- Update various dependencies to fix some known vulnerabilities.
+
+## [1.3.1] - 2020-05-10
+
+### Fixed
+
+- GitHub Actions does not support sequences as input
+
+## [1.3.0] - 2022-05-09
+
+### Added
+
+- Add support for ignores (#1)
+
 ## [1.2.0] - 2020-05-07
 
 ### Fixed

README.md

@@ -1,7 +1,6 @@
 # Rust `audit-check` Action
 
 ![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)
-[![Gitter](https://badges.gitter.im/actions-rs/community.svg)](https://gitter.im/actions-rs/community)
 
 > Security vulnerabilities audit
 
@@ -27,8 +26,8 @@ jobs:
   security_audit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
-      - uses: actions-rs/audit-check@v1
+      - uses: rustsec/audit-check@v2.0.0
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 ```
@@ -37,13 +36,33 @@ It is recommended to add the `paths:` section into the workflow file,
 as it would effectively speed up the CI pipeline, since the audit process
 will not be performed if no dependencies were changed.
 
-
 In case of any security advisories found, [status check](https://help.github.com/en/articles/about-status-checks)
 created by this Action will be marked as "failed".\
 Note that informational advisories are not affecting the check status.
 
 ![Check screenshot](.github/check_screenshot.png)
 
+#### Granular Permissions
+
+These are the typically used permissions:
+
+```yaml
+name: 'rust-audit-check'
+github-token:
+  action-input:
+    input: token
+    is-default: false
+  permissions:
+    issues: write
+    issues-reason: to create issues
+    checks: write
+    checks-reason: to create check
+```
+
+This action only raises issues when it's triggered from a `cron` scheduled workflow or on manual `workflow_dispatch`
+
+When running the action as scheduled it will crate issues but e.g. in PR / push fails the action.
+
 #### Limitations
 
 Due to [token permissions](https://help.github.com/en/articles/virtual-environments-for-github-actions#token-permissions),
@@ -66,8 +85,8 @@ jobs:
   audit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
-      - uses: actions-rs/audit-check@v1
+      - uses: rustsec/audit-check@v2.0.0
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 ```
@@ -83,5 +102,27 @@ For each new advisory (including informal) an issue will be created:
 | Name        | Required | Description                                                                | Type   | Default |
 | ------------| -------- | ---------------------------------------------------------------------------| ------ | --------|
 | `token`     | ✓        | [GitHub token], usually a `${{ secrets.GITHUB_TOKEN }}`                    | string |         |
+| `ignore`    |          | Comma-separated list of advisory ids to ignore                             | string |         |
+| `working-directory`|   | The directory of the Cargo.toml / Cargo.lock files to scan.                | string | `.`     |
 
 [GitHub token]: https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token
+
+## Contribute
+
+### Setting up npm login
+
+This repo uses some npm packages hosted on github.
+To be able to pull these you need to:
+
+1. Under <https://github.com/settings/tokens> - create a `personal access token (classic)` with `read:packages` scope
+
+2. Authenticate to the github npm registry
+
+```sh
+npm login --scope=@clechasseur --auth-type=legacy --registry=https://npm.pkg.github.com
+```
+
+```txt
+Username = Github Username
+Password = Token
+```

action.yml

@@ -8,7 +8,14 @@ inputs:
   token:
     description: GitHub Actions token
     required: true
+  ignore:
+    description: Comma-separated list of advisory ids to ignore
+    required: false
+  working-directory:
+    description: The directory of the Cargo.toml / Cargo.lock files to scan.
+    required: false
+    default: .
 
 runs:
-  using: 'node12'
+  using: 'node20'
   main: 'dist/index.js'

package.json

@@ -1,6 +1,6 @@
 {
     "name": "rust-audit-check",
-    "version": "1.2.0",
+    "version": "2.0.0",
     "private": false,
     "description": "Security audit for security vulnerabilities",
     "main": "lib/main.js",
@@ -18,7 +18,7 @@
     },
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/actions-rs/audit.git"
+        "url": "github:rustsec/audit-check"
     },
     "keywords": [
         "actions",
@@ -31,29 +31,27 @@
     "author": "actions-rs",
     "license": "MIT",
     "bugs": {
-        "url": "https://github.com/actions-rs/audit-check/issues"
+        "url": "https://github.com/rustsec/audit-check/issues"
     },
     "dependencies": {
-        "@actions-rs/core": "0.0.9",
+        "@actions/core": "^1.11.1",
-        "@actions/core": "^1.2.4",
+        "@actions/github": "^6.0.1",
-        "@actions/github": "^2.1.1",
+        "@clechasseur/rs-actions-core": "^3.0.5",
-        "npm-check-updates": "^4.1.2",
+        "nunjucks": "^3.2.4"
-        "nunjucks": "^3.2.1"
     },
     "devDependencies": {
-        "@typescript-eslint/eslint-plugin": "^2.31.0",
+        "@types/jest": "^29.5.12",
-        "ts-node": "^8.10.1",
+        "@types/node": "^20.11.17",
-        "@typescript-eslint/parser": "^2.31.0",
+        "@typescript-eslint/eslint-plugin": "^6.21.0",
-        "eslint": "^6.8.0",
+        "@typescript-eslint/parser": "^6.21.0",
-        "eslint-config-prettier": "^6.11.0",
+        "@vercel/ncc": "0.38.1",
-        "eslint-plugin-prettier": "^3.1.3",
+        "eslint": "^8.56.0",
-        "@types/jest": "^25.2.1",
+        "eslint-config-prettier": "^9.1.0",
-        "@types/node": "^13.13.5",
+        "eslint-plugin-prettier": "^5.1.3",
-        "@zeit/ncc": "^0.22.1",
+        "jest": "^29.7.0",
-        "jest": "^26.0.1",
+        "prettier": "^3.2.5",
-        "jest-circus": "^26.0.1",
+        "ts-jest": "^29.1.2",
-        "ts-jest": "^25.5.0",
+        "ts-node": "^10.9.2",
-        "typescript": "^3.8.3",
+        "typescript": "^5.3.3"
-        "prettier": "^2.0.5"
     }
 }

src/input.ts

@@ -2,15 +2,19 @@
  * Parse action input into a some proper thing.
  */
 
-import { input } from '@actions-rs/core';
+import { input } from '@clechasseur/rs-actions-core';
 
 // Parsed action input
 export interface Input {
     token: string;
+    ignore: string[];
+    workingDirectory: string;
 }
 
 export function get(): Input {
     return {
         token: input.getInput('token', { required: true }),
+        ignore: input.getInputList('ignore', { required: false }),
+        workingDirectory: input.getInput('working-directory', { required: false }) ?? '.',
     };
 }

src/main.ts

@@ -1,29 +1,32 @@
-import * as process from 'process';
 import * as os from 'os';
+import * as process from 'process';
 
 import * as core from '@actions/core';
 import * as github from '@actions/github';
 
-import { Cargo } from '@actions-rs/core';
+import { Cargo } from '@clechasseur/rs-actions-core';
 
 import * as input from './input';
 import * as interfaces from './interfaces';
 import * as reporter from './reporter';
 
-const pkg = require('../package.json'); // eslint-disable-line @typescript-eslint/no-var-requires
+async function getData(
-
+    ignore: string[] | undefined,
-const USER_AGENT = `${pkg.name}/${pkg.version} (${pkg.bugs.url})`;
+    workingDirectory: string,
-
+): Promise<interfaces.Report> {
-async function getData(): Promise<interfaces.Report> {
     const cargo = await Cargo.get();
     await cargo.findOrInstall('cargo-audit');
 
-    await cargo.call(['generate-lockfile']);
-
     let stdout = '';
     try {
         core.startGroup('Calling cargo-audit (JSON output)');
-        await cargo.call(['audit', '--json'], {
+        const commandArray = ['audit'];
+        for (const item of ignore ?? []) {
+            commandArray.push('--ignore', item);
+        }
+        commandArray.push('--json');
+        commandArray.push('--file', `${workingDirectory}/Cargo.lock`);
+        await cargo.call(commandArray, {
             ignoreReturnCode: true,
             listeners: {
                 stdout: (buffer) => {
@@ -43,8 +46,17 @@ async function getData(): Promise<interfaces.Report> {
     return JSON.parse(stdout);
 }
 
+function removeTrailingSlash(str) {
+    if (str[str.length - 1] === '/') {
+        return str.substr(0, str.length - 1);
+    }
+    return str;
+}
+
 export async function run(actionInput: input.Input): Promise<void> {
-    const report = await getData();
+    const ignore = actionInput.ignore;
+    const workingDirectory = removeTrailingSlash(actionInput.workingDirectory);
+    const report = await getData(ignore, workingDirectory);
     let shouldReport = false;
     if (!report.vulnerabilities.found) {
         core.info('No vulnerabilities were found');
@@ -76,20 +88,21 @@ export async function run(actionInput: input.Input): Promise<void> {
         return;
     }
 
-    const client = new github.GitHub(actionInput.token, {
+    // const octokit = github.getOctokit(actionInput.token, {userAgent: USER_AGENT});
-        userAgent: USER_AGENT,
-    });
     const advisories = report.vulnerabilities.list;
-    if (github.context.eventName == 'schedule') {
+    if (
+        github.context.eventName == 'schedule' ||
+        github.context.eventName == 'workflow_dispatch'
+    ) {
         core.debug(
             'Action was triggered on a schedule event, creating an Issues report',
         );
-        await reporter.reportIssues(client, advisories, warnings);
+        await reporter.reportIssues(actionInput.token, advisories, warnings);
     } else {
         core.debug(
             `Action was triggered on a ${github.context.eventName} event, creating a Check report`,
         );
-        await reporter.reportCheck(client, advisories, warnings);
+        await reporter.reportCheck(actionInput.token, advisories, warnings);
     }
 }
 
@@ -98,7 +111,7 @@ async function main(): Promise<void> {
         const actionInput = input.get();
         await run(actionInput);
     } catch (error) {
-        core.setFailed(error.message);
+        core.setFailed((error as Error).message);
     }
 
     return;

src/reporter.ts

@@ -4,14 +4,18 @@ import * as core from '@actions/core';
 import * as github from '@actions/github';
 import * as nunjucks from 'nunjucks';
 
-import { checks } from '@actions-rs/core';
+import { checks } from '@clechasseur/rs-actions-core';
 import * as interfaces from './interfaces';
 import * as templates from './templates';
 
+const pkg = require('../package.json'); // eslint-disable-line @typescript-eslint/no-var-requires
+const USER_AGENT = `${pkg.name}/${pkg.version} (${pkg.bugs.url})`;
+
 interface Stats {
     critical: number;
     notices: number;
     unmaintained: number;
+    unsound: number;
     other: number;
 }
 
@@ -34,6 +38,20 @@ function makeReport(
                 });
                 break;
 
+            case 'unsound':
+                preparedWarnings.push({
+                    advisory: warning.advisory,
+                    package: warning.package,
+                });
+                break;
+
+            case 'notice':
+                preparedWarnings.push({
+                    advisory: warning.advisory,
+                    package: warning.package,
+                });
+                break;
+
             case 'informational':
                 preparedWarnings.push({
                     advisory: warning.advisory,
@@ -72,6 +90,7 @@ function getStats(
     let critical = 0;
     let notices = 0;
     let unmaintained = 0;
+    let unsound = 0;
     let other = 0;
     for (const vulnerability of vulnerabilities) {
         switch (vulnerability.advisory.informational) {
@@ -81,6 +100,9 @@ function getStats(
             case 'unmaintained':
                 unmaintained += 1;
                 break;
+            case 'unsound':
+                unsound += 1;
+                break;
             case null:
                 critical += 1;
                 break;
@@ -96,6 +118,10 @@ function getStats(
                 unmaintained += 1;
                 break;
 
+            case 'unsound':
+                unsound += 1;
+                break;
+
             default:
                 // Both yanked and informational types of kind
                 other += 1;
@@ -107,6 +133,7 @@ function getStats(
         critical: critical,
         notices: notices,
         unmaintained: unmaintained,
+        unsound: unsound,
         other: other,
     };
 }
@@ -115,8 +142,7 @@ function getSummary(stats: Stats): string {
     const blocks: string[] = [];
 
     if (stats.critical > 0) {
-        // TODO: Plural
+        blocks.push(`${stats.critical} advisories`);
-        blocks.push(`${stats.critical} advisory(ies)`);
     }
     if (stats.notices > 0) {
         blocks.push(`${stats.notices} notice${plural(stats.notices)}`);
@@ -124,6 +150,9 @@ function getSummary(stats: Stats): string {
     if (stats.unmaintained > 0) {
         blocks.push(`${stats.unmaintained} unmaintained`);
     }
+    if (stats.unsound > 0) {
+        blocks.push(`${stats.unsound} unsound`);
+    }
     if (stats.other > 0) {
         blocks.push(`${stats.other} other`);
     }
@@ -133,11 +162,12 @@ function getSummary(stats: Stats): string {
 
 /// Create and publish audit results into the Commit Check.
 export async function reportCheck(
-    client: github.GitHub,
+    token: string,
     vulnerabilities: Array<interfaces.Vulnerability>,
     warnings: Array<interfaces.Warning>,
 ): Promise<void> {
-    const reporter = new checks.CheckReporter(client, 'Security audit');
+    const client = github.getOctokit(token, {userAgent: USER_AGENT});
+    const reporter = new checks.CheckReporter(client.rest, 'Security audit');
     const stats = getStats(vulnerabilities, warnings);
     const summary = getSummary(stats);
 
@@ -201,11 +231,12 @@ See https://github.com/actions-rs/clippy-check/issues/2 for details.`);
 }
 
 async function alreadyReported(
-    client: github.GitHub,
+    token: string,
     advisoryId: string,
 ): Promise<boolean> {
     const { owner, repo } = github.context.repo;
-    const results = await client.search.issuesAndPullRequests({
+    const client = github.getOctokit(token, {userAgent: USER_AGENT});
+    const results = await client.rest.search.issuesAndPullRequests({
         q: `${advisoryId} in:title repo:${owner}/${repo}`,
         per_page: 1, // eslint-disable-line @typescript-eslint/camelcase
     });
@@ -222,15 +253,17 @@ will not report an issue against it`,
 }
 
 export async function reportIssues(
-    client: github.GitHub,
+    token: string,
     vulnerabilities: Array<interfaces.Vulnerability>,
     warnings: Array<interfaces.Warning>,
 ): Promise<void> {
     const { owner, repo } = github.context.repo;
 
+    const client = github.getOctokit(token, {userAgent: USER_AGENT});
+
     for (const vulnerability of vulnerabilities) {
         const reported = await alreadyReported(
-            client,
+            token,
             vulnerability.advisory.id,
         );
         if (reported) {
@@ -240,7 +273,7 @@ export async function reportIssues(
         const body = nunjucks.renderString(templates.VULNERABILITY_ISSUE, {
             vulnerability: vulnerability,
         });
-        const issue = await client.issues.create({
+        const issue = await client.rest.issues.create({
             owner: owner,
             repo: repo,
             title: `${vulnerability.advisory.id}: ${vulnerability.advisory.title}`,
@@ -254,6 +287,8 @@ export async function reportIssues(
     for (const warning of warnings) {
         let advisory: interfaces.Advisory;
         switch (warning.kind) {
+            case 'unsound':
+            case 'notice':
             case 'unmaintained':
             case 'informational':
                 advisory = warning.advisory;
@@ -270,7 +305,7 @@ export async function reportIssues(
                 continue;
         }
 
-        const reported = await alreadyReported(client, advisory.id);
+        const reported = await alreadyReported(token, advisory.id);
         if (reported) {
             continue;
         }
@@ -279,7 +314,7 @@ export async function reportIssues(
             warning: warning,
             advisory: advisory,
         });
-        const issue = await client.issues.create({
+        const issue = await client.rest.issues.create({
             owner: owner,
             repo: repo,
             title: `${advisory.id}: ${advisory.title}`,