Public Access
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e9159ac5f7 | ||
|
|
49cdbfff23 | ||
|
|
27d7cd3d63 | ||
|
|
bc91a32ed8 | ||
|
|
139ab94e83 | ||
|
|
71526086eb | ||
|
|
6ef0fcd2dd |
@@ -6,16 +6,10 @@ jobs:
|
|||||||
main:
|
main:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Create npm configuration
|
- uses: actions/checkout@v3
|
||||||
run: echo "//npm.pkg.github.com/:_authToken=${token}" >> ~/.npmrc
|
- uses: actions/setup-node@v3
|
||||||
env:
|
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
with:
|
||||||
node-version-file: '.nvmrc'
|
node-version: 16
|
||||||
cache: 'npm'
|
|
||||||
- run: npm ci
|
- run: npm ci
|
||||||
# octokit types problem ?
|
# octokit types problem ?
|
||||||
# - run: npm run lint
|
# - run: npm run lint
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
@clechasseur:registry=https://npm.pkg.github.com
|
@actions-rs:registry=https://npm.pkg.github.com
|
||||||
|
|||||||
@@ -5,18 +5,6 @@ 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/),
|
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).
|
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
|
## [1.3.2] - 2023-03-13
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
# Rust `audit-check` Action
|
# Rust `audit-check` Action
|
||||||
|
|
||||||

|

|
||||||
|
[](https://gitter.im/actions-rs/community)
|
||||||
|
|
||||||
> Security vulnerabilities audit
|
> Security vulnerabilities audit
|
||||||
|
|
||||||
@@ -26,8 +27,8 @@ jobs:
|
|||||||
security_audit:
|
security_audit:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- uses: rustsec/audit-check@v1.4.1
|
- uses: rustsec/audit-check@v1
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
```
|
```
|
||||||
@@ -43,27 +44,6 @@ Note that informational advisories are not affecting the check status.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
#### 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
|
|
||||||
```
|
|
||||||
|
|
||||||
The action does not raise issues when it is not triggered from a "cron" scheduled workflow.
|
|
||||||
|
|
||||||
When running the action as scheduled it will crate issues but e.g. in PR / push fails the action.
|
|
||||||
|
|
||||||
#### Limitations
|
#### Limitations
|
||||||
|
|
||||||
Due to [token permissions](https://help.github.com/en/articles/virtual-environments-for-github-actions#token-permissions),
|
Due to [token permissions](https://help.github.com/en/articles/virtual-environments-for-github-actions#token-permissions),
|
||||||
@@ -86,8 +66,8 @@ jobs:
|
|||||||
audit:
|
audit:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- uses: rustsec/audit-check@v1.4.1
|
- uses: actions-rs/audit-check@v1
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
```
|
```
|
||||||
@@ -104,6 +84,5 @@ For each new advisory (including informal) an issue will be created:
|
|||||||
| ------------| -------- | ---------------------------------------------------------------------------| ------ | --------|
|
| ------------| -------- | ---------------------------------------------------------------------------| ------ | --------|
|
||||||
| `token` | ✓ | [GitHub token], usually a `${{ secrets.GITHUB_TOKEN }}` | string | |
|
| `token` | ✓ | [GitHub token], usually a `${{ secrets.GITHUB_TOKEN }}` | string | |
|
||||||
| `ignore` | | Comma-separated list of advisory ids to ignore | 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
|
[GitHub token]: https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token
|
||||||
|
|||||||
+1
-5
@@ -11,11 +11,7 @@ inputs:
|
|||||||
ignore:
|
ignore:
|
||||||
description: Comma-separated list of advisory ids to ignore
|
description: Comma-separated list of advisory ids to ignore
|
||||||
required: false
|
required: false
|
||||||
working-directory:
|
|
||||||
description: The directory of the Cargo.toml / Cargo.lock files to scan.
|
|
||||||
required: false
|
|
||||||
default: .
|
|
||||||
|
|
||||||
runs:
|
runs:
|
||||||
using: 'node20'
|
using: 'node16'
|
||||||
main: 'dist/index.js'
|
main: 'dist/index.js'
|
||||||
|
|||||||
BIN
Binary file not shown.
Vendored
+1
-3
File diff suppressed because one or more lines are too long
Generated
+19617
-3424
File diff suppressed because it is too large
Load Diff
+20
-16
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "rust-audit-check",
|
"name": "rust-audit-check",
|
||||||
"version": "2.0.0",
|
"version": "1.3.2",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "Security audit for security vulnerabilities",
|
"description": "Security audit for security vulnerabilities",
|
||||||
"main": "lib/main.js",
|
"main": "lib/main.js",
|
||||||
@@ -34,22 +34,26 @@
|
|||||||
"url": "https://github.com/actions-rs/audit-check/issues"
|
"url": "https://github.com/actions-rs/audit-check/issues"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@clechasseur/rs-actions-core": "^3.0.5",
|
"@rinse-repeat/actions-rs-core": "0.1.8",
|
||||||
"nunjucks": "^3.2.4"
|
"@actions/core": "^1.2.6",
|
||||||
|
"@actions/github": "^5.1.0",
|
||||||
|
"npm-check-updates": "^16.8.0",
|
||||||
|
"nunjucks": "^3.2.3"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@typescript-eslint/parser": "^6.21.0",
|
"@typescript-eslint/eslint-plugin": "^5.56.0",
|
||||||
"@typescript-eslint/eslint-plugin": "^6.21.0",
|
"ts-node": "^10.9.1",
|
||||||
"ts-node": "^10.9.2",
|
"@typescript-eslint/parser": "^5.56.0",
|
||||||
"eslint": "^8.56.0",
|
"eslint": "^8.36.0",
|
||||||
"eslint-config-prettier": "^9.1.0",
|
"eslint-config-prettier": "^6.11.0",
|
||||||
"eslint-plugin-prettier": "^5.1.3",
|
"eslint-plugin-prettier": "^3.1.3",
|
||||||
"@types/jest": "^29.5.12",
|
"@types/jest": "^26.0.1",
|
||||||
"@types/node": "^20.11.17",
|
"@types/node": "^16.11.7",
|
||||||
"@vercel/ncc": "0.38.1",
|
"@vincentriemer/ncc": "^0.20.5",
|
||||||
"jest": "^29.7.0",
|
"jest": "^26.0.1",
|
||||||
"ts-jest": "^29.1.2",
|
"jest-circus": "^26.0.1",
|
||||||
"typescript": "^5.3.3",
|
"ts-jest": "^26.0.1",
|
||||||
"prettier": "^3.2.5"
|
"typescript": "^3.8.3",
|
||||||
|
"prettier": "^2.0.5"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+3
-4
@@ -2,19 +2,18 @@
|
|||||||
* Parse action input into a some proper thing.
|
* Parse action input into a some proper thing.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { input } from '@clechasseur/rs-actions-core';
|
import { input } from '@rinse-repeat/actions-rs-core';
|
||||||
|
import { getInputList } from '@rinse-repeat/actions-rs-core/dist/input';
|
||||||
|
|
||||||
// Parsed action input
|
// Parsed action input
|
||||||
export interface Input {
|
export interface Input {
|
||||||
token: string;
|
token: string;
|
||||||
ignore: string[];
|
ignore: string[];
|
||||||
workingDirectory: string;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export function get(): Input {
|
export function get(): Input {
|
||||||
return {
|
return {
|
||||||
token: input.getInput('token', { required: true }),
|
token: input.getInput('token', { required: true }),
|
||||||
ignore: input.getInputList('ignore', { required: false }),
|
ignore: getInputList('ignore', { required: false }),
|
||||||
workingDirectory: input.getInput('working-directory', { required: false }) ?? '.',
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
+5
-13
@@ -4,7 +4,7 @@ import * as os from 'os';
|
|||||||
import * as core from '@actions/core';
|
import * as core from '@actions/core';
|
||||||
import * as github from '@actions/github';
|
import * as github from '@actions/github';
|
||||||
|
|
||||||
import { Cargo } from '@clechasseur/rs-actions-core';
|
import { Cargo } from '@rinse-repeat/actions-rs-core';
|
||||||
|
|
||||||
import * as input from './input';
|
import * as input from './input';
|
||||||
import * as interfaces from './interfaces';
|
import * as interfaces from './interfaces';
|
||||||
@@ -12,11 +12,12 @@ import * as reporter from './reporter';
|
|||||||
|
|
||||||
async function getData(
|
async function getData(
|
||||||
ignore: string[] | undefined,
|
ignore: string[] | undefined,
|
||||||
workingDirectory: string,
|
|
||||||
): Promise<interfaces.Report> {
|
): Promise<interfaces.Report> {
|
||||||
const cargo = await Cargo.get();
|
const cargo = await Cargo.get();
|
||||||
await cargo.findOrInstall('cargo-audit');
|
await cargo.findOrInstall('cargo-audit');
|
||||||
|
|
||||||
|
await cargo.call(['generate-lockfile']);
|
||||||
|
|
||||||
let stdout = '';
|
let stdout = '';
|
||||||
try {
|
try {
|
||||||
core.startGroup('Calling cargo-audit (JSON output)');
|
core.startGroup('Calling cargo-audit (JSON output)');
|
||||||
@@ -25,7 +26,6 @@ async function getData(
|
|||||||
commandArray.push('--ignore', item);
|
commandArray.push('--ignore', item);
|
||||||
}
|
}
|
||||||
commandArray.push('--json');
|
commandArray.push('--json');
|
||||||
commandArray.push('--file', `${workingDirectory}/Cargo.lock`);
|
|
||||||
await cargo.call(commandArray, {
|
await cargo.call(commandArray, {
|
||||||
ignoreReturnCode: true,
|
ignoreReturnCode: true,
|
||||||
listeners: {
|
listeners: {
|
||||||
@@ -46,17 +46,9 @@ async function getData(
|
|||||||
return JSON.parse(stdout);
|
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> {
|
export async function run(actionInput: input.Input): Promise<void> {
|
||||||
const ignore = actionInput.ignore;
|
const ignore = actionInput.ignore;
|
||||||
const workingDirectory = removeTrailingSlash(actionInput.workingDirectory);
|
const report = await getData(ignore);
|
||||||
const report = await getData(ignore, workingDirectory);
|
|
||||||
let shouldReport = false;
|
let shouldReport = false;
|
||||||
if (!report.vulnerabilities.found) {
|
if (!report.vulnerabilities.found) {
|
||||||
core.info('No vulnerabilities were found');
|
core.info('No vulnerabilities were found');
|
||||||
@@ -108,7 +100,7 @@ async function main(): Promise<void> {
|
|||||||
const actionInput = input.get();
|
const actionInput = input.get();
|
||||||
await run(actionInput);
|
await run(actionInput);
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
core.setFailed((error as Error).message);
|
core.setFailed(error.message);
|
||||||
}
|
}
|
||||||
|
|
||||||
return;
|
return;
|
||||||
|
|||||||
+3
-31
@@ -4,7 +4,7 @@ import * as core from '@actions/core';
|
|||||||
import * as github from '@actions/github';
|
import * as github from '@actions/github';
|
||||||
import * as nunjucks from 'nunjucks';
|
import * as nunjucks from 'nunjucks';
|
||||||
|
|
||||||
import { checks } from '@clechasseur/rs-actions-core';
|
import { checks } from '@rinse-repeat/actions-rs-core';
|
||||||
import * as interfaces from './interfaces';
|
import * as interfaces from './interfaces';
|
||||||
import * as templates from './templates';
|
import * as templates from './templates';
|
||||||
|
|
||||||
@@ -15,7 +15,6 @@ interface Stats {
|
|||||||
critical: number;
|
critical: number;
|
||||||
notices: number;
|
notices: number;
|
||||||
unmaintained: number;
|
unmaintained: number;
|
||||||
unsound: number;
|
|
||||||
other: number;
|
other: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -38,20 +37,6 @@ function makeReport(
|
|||||||
});
|
});
|
||||||
break;
|
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':
|
case 'informational':
|
||||||
preparedWarnings.push({
|
preparedWarnings.push({
|
||||||
advisory: warning.advisory,
|
advisory: warning.advisory,
|
||||||
@@ -90,7 +75,6 @@ function getStats(
|
|||||||
let critical = 0;
|
let critical = 0;
|
||||||
let notices = 0;
|
let notices = 0;
|
||||||
let unmaintained = 0;
|
let unmaintained = 0;
|
||||||
let unsound = 0;
|
|
||||||
let other = 0;
|
let other = 0;
|
||||||
for (const vulnerability of vulnerabilities) {
|
for (const vulnerability of vulnerabilities) {
|
||||||
switch (vulnerability.advisory.informational) {
|
switch (vulnerability.advisory.informational) {
|
||||||
@@ -100,9 +84,6 @@ function getStats(
|
|||||||
case 'unmaintained':
|
case 'unmaintained':
|
||||||
unmaintained += 1;
|
unmaintained += 1;
|
||||||
break;
|
break;
|
||||||
case 'unsound':
|
|
||||||
unsound += 1;
|
|
||||||
break;
|
|
||||||
case null:
|
case null:
|
||||||
critical += 1;
|
critical += 1;
|
||||||
break;
|
break;
|
||||||
@@ -118,10 +99,6 @@ function getStats(
|
|||||||
unmaintained += 1;
|
unmaintained += 1;
|
||||||
break;
|
break;
|
||||||
|
|
||||||
case 'unsound':
|
|
||||||
unsound += 1;
|
|
||||||
break;
|
|
||||||
|
|
||||||
default:
|
default:
|
||||||
// Both yanked and informational types of kind
|
// Both yanked and informational types of kind
|
||||||
other += 1;
|
other += 1;
|
||||||
@@ -133,7 +110,6 @@ function getStats(
|
|||||||
critical: critical,
|
critical: critical,
|
||||||
notices: notices,
|
notices: notices,
|
||||||
unmaintained: unmaintained,
|
unmaintained: unmaintained,
|
||||||
unsound: unsound,
|
|
||||||
other: other,
|
other: other,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
@@ -142,7 +118,8 @@ function getSummary(stats: Stats): string {
|
|||||||
const blocks: string[] = [];
|
const blocks: string[] = [];
|
||||||
|
|
||||||
if (stats.critical > 0) {
|
if (stats.critical > 0) {
|
||||||
blocks.push(`${stats.critical} advisories`);
|
// TODO: Plural
|
||||||
|
blocks.push(`${stats.critical} advisory(ies)`);
|
||||||
}
|
}
|
||||||
if (stats.notices > 0) {
|
if (stats.notices > 0) {
|
||||||
blocks.push(`${stats.notices} notice${plural(stats.notices)}`);
|
blocks.push(`${stats.notices} notice${plural(stats.notices)}`);
|
||||||
@@ -150,9 +127,6 @@ function getSummary(stats: Stats): string {
|
|||||||
if (stats.unmaintained > 0) {
|
if (stats.unmaintained > 0) {
|
||||||
blocks.push(`${stats.unmaintained} unmaintained`);
|
blocks.push(`${stats.unmaintained} unmaintained`);
|
||||||
}
|
}
|
||||||
if (stats.unsound > 0) {
|
|
||||||
blocks.push(`${stats.unsound} unsound`);
|
|
||||||
}
|
|
||||||
if (stats.other > 0) {
|
if (stats.other > 0) {
|
||||||
blocks.push(`${stats.other} other`);
|
blocks.push(`${stats.other} other`);
|
||||||
}
|
}
|
||||||
@@ -287,8 +261,6 @@ export async function reportIssues(
|
|||||||
for (const warning of warnings) {
|
for (const warning of warnings) {
|
||||||
let advisory: interfaces.Advisory;
|
let advisory: interfaces.Advisory;
|
||||||
switch (warning.kind) {
|
switch (warning.kind) {
|
||||||
case 'unsound':
|
|
||||||
case 'notice':
|
|
||||||
case 'unmaintained':
|
case 'unmaintained':
|
||||||
case 'informational':
|
case 'informational':
|
||||||
advisory = warning.advisory;
|
advisory = warning.advisory;
|
||||||
|
|||||||
Reference in New Issue
Block a user