Compare commits
69
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c2c8e8afdf | ||
|
|
ef02dcfae5 | ||
|
|
88ac301612 | ||
|
|
6ec0860adb | ||
|
|
532af8af79 | ||
|
|
4f3e64cb63 | ||
|
|
ba126a2b5e | ||
|
|
3867ba47a1 | ||
|
|
95613fb241 | ||
|
|
b2a1607a55 | ||
|
|
2dab46ceb6 | ||
|
|
9dc6831a72 | ||
|
|
b8f802ae8b | ||
|
|
542c22bbcc | ||
|
|
d519ae0726 | ||
|
|
fd7a65e0c0 | ||
|
|
f2e6656b8e | ||
|
|
c3380f58e7 | ||
|
|
61614eea5c | ||
|
|
e24c2a9074 | ||
|
|
9e5a1e06d2 | ||
|
|
580d4aff21 | ||
|
|
def7784df6 | ||
|
|
4e404e7097 | ||
|
|
4651f806c0 | ||
|
|
55e972012f | ||
|
|
c2dd1df1ec | ||
|
|
87ab9bb01b | ||
|
|
24900ce153 | ||
|
|
484c81f0bd | ||
|
|
eec1ec9904 | ||
|
|
b06100ab07 | ||
|
|
ccb8edd7db | ||
|
|
9a005994da | ||
|
|
57a8b1e21b | ||
|
|
0d73e3f2be | ||
|
|
2548367d4f | ||
|
|
f4e8bae046 | ||
|
|
0486c4aa49 | ||
|
|
e9b2cefbdf | ||
|
|
45bb4038a3 | ||
|
|
bd218ad0db | ||
|
|
bb6e4f037b | ||
|
|
4d6ee9870b | ||
|
|
22e8414d9e | ||
|
|
9d8c9cae4a | ||
|
|
8253d9c026 | ||
|
|
c0e357efe3 | ||
|
|
bced3cb77f | ||
|
|
32cff21fdd | ||
|
|
33f07475db | ||
|
|
ca5b36b219 | ||
|
|
c9a714d97f | ||
|
|
7d7fafdda7 | ||
|
|
20d6de2969 | ||
|
|
da22b2f914 | ||
|
|
ee52af96f0 | ||
|
|
ca1bdd855b | ||
|
|
eb46c951aa | ||
|
|
961916f218 | ||
|
|
965ff037e1 | ||
|
|
115c3be05f | ||
|
|
d19588d87c | ||
|
|
f3a82307fe | ||
|
|
820c5ce485 | ||
|
|
b8e2bbc9cd | ||
|
|
0fedf7318f | ||
|
|
ae2702efaf | ||
|
|
cfcbc966ee |
@@ -1,4 +0,0 @@
|
|||||||
lib/
|
|
||||||
dist/
|
|
||||||
node_modules/
|
|
||||||
coverage/
|
|
||||||
@@ -1,83 +0,0 @@
|
|||||||
env:
|
|
||||||
node: true
|
|
||||||
es6: true
|
|
||||||
jest: true
|
|
||||||
|
|
||||||
globals:
|
|
||||||
Atomics: readonly
|
|
||||||
SharedArrayBuffer: readonly
|
|
||||||
|
|
||||||
ignorePatterns:
|
|
||||||
- '!.*'
|
|
||||||
- '**/node_modules/.*'
|
|
||||||
- '**/dist/.*'
|
|
||||||
- '**/coverage/.*'
|
|
||||||
- '*.json'
|
|
||||||
|
|
||||||
parser: '@typescript-eslint/parser'
|
|
||||||
|
|
||||||
parserOptions:
|
|
||||||
ecmaVersion: 2023
|
|
||||||
sourceType: module
|
|
||||||
project:
|
|
||||||
- './.github/linters/tsconfig.json'
|
|
||||||
- './tsconfig.json'
|
|
||||||
|
|
||||||
plugins:
|
|
||||||
- jest
|
|
||||||
- '@typescript-eslint'
|
|
||||||
|
|
||||||
extends:
|
|
||||||
- eslint:recommended
|
|
||||||
- plugin:@typescript-eslint/eslint-recommended
|
|
||||||
- plugin:@typescript-eslint/recommended
|
|
||||||
- plugin:github/recommended
|
|
||||||
- plugin:jest/recommended
|
|
||||||
|
|
||||||
rules:
|
|
||||||
{
|
|
||||||
'camelcase': 'off',
|
|
||||||
'eslint-comments/no-use': 'off',
|
|
||||||
'eslint-comments/no-unused-disable': 'off',
|
|
||||||
'i18n-text/no-en': 'off',
|
|
||||||
'import/no-namespace': 'off',
|
|
||||||
'no-console': 'off',
|
|
||||||
'no-unused-vars': 'off',
|
|
||||||
'prettier/prettier': 'error',
|
|
||||||
'semi': 'off',
|
|
||||||
'@typescript-eslint/array-type': 'error',
|
|
||||||
'@typescript-eslint/await-thenable': 'error',
|
|
||||||
'@typescript-eslint/ban-ts-comment': 'error',
|
|
||||||
'@typescript-eslint/consistent-type-assertions': 'error',
|
|
||||||
'@typescript-eslint/explicit-member-accessibility':
|
|
||||||
['error', { 'accessibility': 'no-public' }],
|
|
||||||
'@typescript-eslint/explicit-function-return-type':
|
|
||||||
['error', { 'allowExpressions': true }],
|
|
||||||
'@typescript-eslint/func-call-spacing': ['error', 'never'],
|
|
||||||
'@typescript-eslint/no-array-constructor': 'error',
|
|
||||||
'@typescript-eslint/no-empty-interface': 'error',
|
|
||||||
'@typescript-eslint/no-explicit-any': 'error',
|
|
||||||
'@typescript-eslint/no-extraneous-class': 'error',
|
|
||||||
'@typescript-eslint/no-for-in-array': 'error',
|
|
||||||
'@typescript-eslint/no-inferrable-types': 'error',
|
|
||||||
'@typescript-eslint/no-misused-new': 'error',
|
|
||||||
'@typescript-eslint/no-namespace': 'error',
|
|
||||||
'@typescript-eslint/no-non-null-assertion': 'warn',
|
|
||||||
'@typescript-eslint/no-require-imports': 'error',
|
|
||||||
'@typescript-eslint/no-unnecessary-qualifier': 'error',
|
|
||||||
'@typescript-eslint/no-unnecessary-type-assertion': 'error',
|
|
||||||
'@typescript-eslint/no-unused-vars': 'error',
|
|
||||||
'@typescript-eslint/no-useless-constructor': 'error',
|
|
||||||
'@typescript-eslint/no-var-requires': 'error',
|
|
||||||
'@typescript-eslint/prefer-for-of': 'warn',
|
|
||||||
'@typescript-eslint/prefer-function-type': 'warn',
|
|
||||||
'@typescript-eslint/prefer-includes': 'error',
|
|
||||||
'@typescript-eslint/prefer-string-starts-ends-with': 'error',
|
|
||||||
'@typescript-eslint/promise-function-async': 'error',
|
|
||||||
'@typescript-eslint/require-array-sort-compare': 'error',
|
|
||||||
'@typescript-eslint/restrict-plus-operands': 'error',
|
|
||||||
'@typescript-eslint/semi': ['error', 'never'],
|
|
||||||
'@typescript-eslint/space-before-function-paren': 'off',
|
|
||||||
'@typescript-eslint/type-annotation-spacing': 'error',
|
|
||||||
'@typescript-eslint/unbound-method': 'error'
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
rules:
|
|
||||||
document-end: disable
|
|
||||||
document-start:
|
|
||||||
level: warning
|
|
||||||
present: false
|
|
||||||
line-length:
|
|
||||||
level: warning
|
|
||||||
max: 80
|
|
||||||
allow-non-breakable-words: true
|
|
||||||
allow-non-breakable-inline-mappings: true
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "https://json.schemastore.org/tsconfig",
|
|
||||||
"extends": "../../tsconfig.json",
|
|
||||||
"compilerOptions": {
|
|
||||||
"noEmit": true
|
|
||||||
},
|
|
||||||
"include": ["../../__tests__/**/*", "../../src/**/*"],
|
|
||||||
"exclude": ["../../dist", "../../node_modules", "../../coverage", "*.json"]
|
|
||||||
}
|
|
||||||
@@ -28,11 +28,11 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
id: checkout
|
id: checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
||||||
|
|
||||||
- name: Setup Node.js
|
- name: Setup Node.js
|
||||||
id: setup-node
|
id: setup-node
|
||||||
uses: actions/setup-node@v4
|
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
|
||||||
with:
|
with:
|
||||||
node-version-file: .node-version
|
node-version-file: .node-version
|
||||||
cache: npm
|
cache: npm
|
||||||
@@ -60,7 +60,7 @@ jobs:
|
|||||||
- if: ${{ failure() && steps.diff.outcome == 'failure' }}
|
- if: ${{ failure() && steps.diff.outcome == 'failure' }}
|
||||||
name: Upload Artifact
|
name: Upload Artifact
|
||||||
id: upload
|
id: upload
|
||||||
uses: actions/upload-artifact@v4
|
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
|
||||||
with:
|
with:
|
||||||
name: dist
|
name: dist
|
||||||
path: dist/
|
path: dist/
|
||||||
|
|||||||
@@ -21,11 +21,11 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
id: checkout
|
id: checkout
|
||||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
||||||
|
|
||||||
- name: Setup Node.js
|
- name: Setup Node.js
|
||||||
id: setup-node
|
id: setup-node
|
||||||
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
|
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
|
||||||
with:
|
with:
|
||||||
node-version-file: .node-version
|
node-version-file: .node-version
|
||||||
cache: npm
|
cache: npm
|
||||||
@@ -57,7 +57,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
id: checkout
|
id: checkout
|
||||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
||||||
- name: Run attest-sbom
|
- name: Run attest-sbom
|
||||||
id: attest-sbom
|
id: attest-sbom
|
||||||
uses: ./
|
uses: ./
|
||||||
|
|||||||
@@ -32,19 +32,19 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
id: checkout
|
id: checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
||||||
|
|
||||||
- name: Initialize CodeQL
|
- name: Initialize CodeQL
|
||||||
id: initialize
|
id: initialize
|
||||||
uses: github/codeql-action/init@v3
|
uses: github/codeql-action/init@1b168cd39490f61582a9beae412bb7057a6b2c4e # v4.31.8
|
||||||
with:
|
with:
|
||||||
languages: ${{ matrix.language }}
|
languages: ${{ matrix.language }}
|
||||||
source-root: src
|
source-root: src
|
||||||
|
|
||||||
- name: Autobuild
|
- name: Autobuild
|
||||||
id: autobuild
|
id: autobuild
|
||||||
uses: github/codeql-action/autobuild@v3
|
uses: github/codeql-action/autobuild@1b168cd39490f61582a9beae412bb7057a6b2c4e # v4.31.8
|
||||||
|
|
||||||
- name: Perform CodeQL Analysis
|
- name: Perform CodeQL Analysis
|
||||||
id: analyze
|
id: analyze
|
||||||
uses: github/codeql-action/analyze@v3
|
uses: github/codeql-action/analyze@1b168cd39490f61582a9beae412bb7057a6b2c4e # v4.31.8
|
||||||
|
|||||||
@@ -1,50 +0,0 @@
|
|||||||
name: Lint Codebase
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
packages: read
|
|
||||||
statuses: write
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
lint:
|
|
||||||
name: Lint Codebase
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
id: checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Setup Node.js
|
|
||||||
id: setup-node
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: .node-version
|
|
||||||
cache: npm
|
|
||||||
|
|
||||||
- name: Install Dependencies
|
|
||||||
id: install
|
|
||||||
run: npm ci
|
|
||||||
|
|
||||||
- name: Lint Codebase
|
|
||||||
id: super-linter
|
|
||||||
uses: super-linter/super-linter/slim@v7
|
|
||||||
env:
|
|
||||||
DEFAULT_BRANCH: main
|
|
||||||
FILTER_REGEX_EXCLUDE: dist/**/*
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
TYPESCRIPT_DEFAULT_STYLE: prettier
|
|
||||||
VALIDATE_ALL_CODEBASE: true
|
|
||||||
VALIDATE_JAVASCRIPT_STANDARD: false
|
|
||||||
VALIDATE_TYPESCRIPT_STANDARD: false
|
|
||||||
VALIDATE_JSCPD: false
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
name: 'Publish Immutable Action Version'
|
|
||||||
|
|
||||||
on:
|
|
||||||
release:
|
|
||||||
types: [published]
|
|
||||||
|
|
||||||
permissions: {}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
publish:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
id-token: write
|
|
||||||
packages: write
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checking out
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: Publish
|
|
||||||
id: publish
|
|
||||||
uses: actions/[email protected]
|
|
||||||
+1
-1
@@ -1 +1 @@
|
|||||||
20.6.0
|
24.5.0
|
||||||
|
|||||||
@@ -45,17 +45,21 @@ attest:
|
|||||||
permissions:
|
permissions:
|
||||||
id-token: write
|
id-token: write
|
||||||
attestations: write
|
attestations: write
|
||||||
|
artifact-metadata: write
|
||||||
```
|
```
|
||||||
|
|
||||||
The `id-token` permission gives the action the ability to mint the OIDC token
|
The `id-token` permission gives the action the ability to mint the OIDC token
|
||||||
necessary to request a Sigstore signing certificate. The `attestations`
|
necessary to request a Sigstore signing certificate. The `attestations`
|
||||||
permission is necessary to persist the attestation.
|
permission is necessary to persist the attestation.
|
||||||
|
The `artifact-metadata` permission is required to generate artifact
|
||||||
|
metadata storage records. If this permission is not included, the action
|
||||||
|
will continue without creating the record.
|
||||||
|
|
||||||
1. Add the following to your workflow after your artifact has been built and
|
1. Add the following to your workflow after your artifact has been built and
|
||||||
your SBOM has been generated:
|
your SBOM has been generated:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/attest-sbom@v2
|
- uses: actions/attest-sbom@v3
|
||||||
with:
|
with:
|
||||||
subject-path: '<PATH TO ARTIFACT>'
|
subject-path: '<PATH TO ARTIFACT>'
|
||||||
sbom-path: '<PATH TO SBOM>'
|
sbom-path: '<PATH TO SBOM>'
|
||||||
@@ -70,23 +74,28 @@ attest:
|
|||||||
See [action.yml](action.yml)
|
See [action.yml](action.yml)
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/attest-sbom@v2
|
- uses: actions/attest-sbom@v3
|
||||||
with:
|
with:
|
||||||
# Path to the artifact serving as the subject of the attestation. Must
|
# Path to the artifact serving as the subject of the attestation. Must
|
||||||
# specify exactly one of "subject-path" or "subject-digest". May contain a
|
# specify exactly one of "subject-path", "subject-digest", or
|
||||||
# glob pattern or list of paths (total subject count cannot exceed 1024).
|
# "subject-checksums". May contain a glob pattern or list of paths
|
||||||
|
# (total subject count cannot exceed 1024).
|
||||||
subject-path:
|
subject-path:
|
||||||
|
|
||||||
# SHA256 digest of the subject for the attestation. Must be in the form
|
# SHA256 digest of the subject for the attestation. Must be in the form
|
||||||
# "sha256:hex_digest" (e.g. "sha256:abc123..."). Must specify exactly one
|
# "sha256:hex_digest" (e.g. "sha256:abc123..."). Must specify exactly one
|
||||||
# of "subject-path" or "subject-digest".
|
# of "subject-path", "subject-digest", or "subject-checksums".
|
||||||
subject-digest:
|
subject-digest:
|
||||||
|
|
||||||
# Subject name as it should appear in the attestation. Required unless
|
# Subject name as it should appear in the attestation. Required when
|
||||||
# "subject-path" is specified, in which case it will be inferred from the
|
# identifying the subject with the "subject-digest" input.
|
||||||
# path.
|
|
||||||
subject-name:
|
subject-name:
|
||||||
|
|
||||||
|
# Path to checksums file containing digest and name of subjects for
|
||||||
|
# attestation. Must specify exactly one of "subject-path", "subject-digest",
|
||||||
|
# or "subject-checksums".
|
||||||
|
subject-checksums:
|
||||||
|
|
||||||
# Path to the JSON-formatted SBOM file to attest. File size cannot exceed
|
# Path to the JSON-formatted SBOM file to attest. File size cannot exceed
|
||||||
# 16MB.
|
# 16MB.
|
||||||
sbom-path:
|
sbom-path:
|
||||||
@@ -96,6 +105,12 @@ See [action.yml](action.yml)
|
|||||||
# the "subject-digest" parameter be specified. Defaults to false.
|
# the "subject-digest" parameter be specified. Defaults to false.
|
||||||
push-to-registry:
|
push-to-registry:
|
||||||
|
|
||||||
|
# Whether to create a storage record for the artifact.
|
||||||
|
# Requires that push-to-registry is set to true.
|
||||||
|
# Requires that the "subject-name" parameter specify the fully-qualified
|
||||||
|
# image name. Defaults to true.
|
||||||
|
create-storage-record:
|
||||||
|
|
||||||
# Whether to attach a list of generated attestations to the workflow run
|
# Whether to attach a list of generated attestations to the workflow run
|
||||||
# summary page. Defaults to true.
|
# summary page. Defaults to true.
|
||||||
show-summary:
|
show-summary:
|
||||||
@@ -122,6 +137,10 @@ Attestations are saved in the JSON-serialized [Sigstore bundle][8] format.
|
|||||||
If multiple subjects are being attested at the same time, a single attestation
|
If multiple subjects are being attested at the same time, a single attestation
|
||||||
will be created with references to each of the supplied subjects.
|
will be created with references to each of the supplied subjects.
|
||||||
|
|
||||||
|
The absolute path to the generated attestation is appended to the file
|
||||||
|
`${RUNNER_TEMP}/created_attestation_paths.txt`. This file will accumulate the
|
||||||
|
paths to all attestations created over the course of a single workflow.
|
||||||
|
|
||||||
## Attestation Limits
|
## Attestation Limits
|
||||||
|
|
||||||
### Subject Limits
|
### Subject Limits
|
||||||
@@ -165,7 +184,7 @@ jobs:
|
|||||||
format: 'spdx-json'
|
format: 'spdx-json'
|
||||||
output-file: 'sbom.spdx.json'
|
output-file: 'sbom.spdx.json'
|
||||||
- name: Attest
|
- name: Attest
|
||||||
uses: actions/attest-sbom@v2
|
uses: actions/attest-sbom@v3
|
||||||
with:
|
with:
|
||||||
subject-path: '${{ github.workspace }}/my-app'
|
subject-path: '${{ github.workspace }}/my-app'
|
||||||
sbom-path: 'sbom.spdx.json'
|
sbom-path: 'sbom.spdx.json'
|
||||||
@@ -177,7 +196,7 @@ If you are generating multiple artifacts, you can attest all of them at the same
|
|||||||
time by using a wildcard in the `subject-path` input.
|
time by using a wildcard in the `subject-path` input.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/attest-sbom@v2
|
- uses: actions/attest-sbom@v3
|
||||||
with:
|
with:
|
||||||
subject-path: 'dist/**/my-bin-*'
|
subject-path: 'dist/**/my-bin-*'
|
||||||
sbom-path: '${{ github.workspace }}/my-bin.sbom.spdx.json'
|
sbom-path: '${{ github.workspace }}/my-bin.sbom.spdx.json'
|
||||||
@@ -190,19 +209,54 @@ Alternatively, you can explicitly list multiple subjects with either a comma or
|
|||||||
newline delimited list:
|
newline delimited list:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/attest-sbom@v2
|
- uses: actions/attest-sbom@v3
|
||||||
with:
|
with:
|
||||||
subject-path: 'dist/foo, dist/bar'
|
subject-path: 'dist/foo, dist/bar'
|
||||||
```
|
```
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/attest-sbom@v2
|
- uses: actions/attest-sbom@v3
|
||||||
with:
|
with:
|
||||||
subject-path: |
|
subject-path: |
|
||||||
dist/foo
|
dist/foo
|
||||||
dist/bar
|
dist/bar
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Identify Subjects with Checksums File
|
||||||
|
|
||||||
|
If you are using tools like
|
||||||
|
[goreleaser](https://goreleaser.com/customization/checksum/) or
|
||||||
|
[jreleaser](https://jreleaser.org/guide/latest/reference/checksum.html) which
|
||||||
|
generate a checksums file you can identify the attestation subjects by passing
|
||||||
|
the path of the checksums file to the `subject-checksums` input. Each of the
|
||||||
|
artifacts identified in the checksums file will be listed as a subject for the
|
||||||
|
attestation.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- name: Calculate artifact digests
|
||||||
|
run: |
|
||||||
|
shasum -a 256 foo_0.0.1_* > subject.checksums.txt
|
||||||
|
- uses: actions/attest-sbom@v3
|
||||||
|
with:
|
||||||
|
subject-checksums: subject.checksums.txt
|
||||||
|
sbom-path: sbom.spdx.json
|
||||||
|
```
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD038 -->
|
||||||
|
|
||||||
|
The file referenced by the `subject-checksums` input must conform to the same
|
||||||
|
format used by the shasum tools. Each subject should be listed on a separate
|
||||||
|
line including the hex-encoded digest (either SHA256 or SHA512), a space, a
|
||||||
|
single character flag indicating either binary (`*`) or text (` `) input mode,
|
||||||
|
and the filename.
|
||||||
|
|
||||||
|
<!-- markdownlint-enable MD038 -->
|
||||||
|
|
||||||
|
```text
|
||||||
|
b569bf992b287f55d78bf8ee476497e9b7e9d2bf1c338860bfb905016218c740 foo_0.0.1_darwin_amd64
|
||||||
|
a54fc515e616cac7fcf11a49d5c5ec9ec315948a5935c1e11dd610b834b14dde foo_0.0.1_darwin_arm64
|
||||||
|
```
|
||||||
|
|
||||||
### Container Image
|
### Container Image
|
||||||
|
|
||||||
When working with container images you can invoke the action with the
|
When working with container images you can invoke the action with the
|
||||||
@@ -214,6 +268,10 @@ fully-qualified image name (e.g. "ghcr.io/user/app" or
|
|||||||
"acme.azurecr.io/user/app"). Do NOT include a tag as part of the image name --
|
"acme.azurecr.io/user/app"). Do NOT include a tag as part of the image name --
|
||||||
the specific image being attested is identified by the supplied digest.
|
the specific image being attested is identified by the supplied digest.
|
||||||
|
|
||||||
|
If the `push-to-registry` option is set to true, the Action will also
|
||||||
|
emit an Artifact Metadata Storage Record. If you do not want to emit a
|
||||||
|
storage record, set `create-storage-record` to `false`.
|
||||||
|
|
||||||
> **NOTE**: When pushing to Docker Hub, please use "index.docker.io" as the
|
> **NOTE**: When pushing to Docker Hub, please use "index.docker.io" as the
|
||||||
> registry portion of the image name.
|
> registry portion of the image name.
|
||||||
|
|
||||||
@@ -259,7 +317,7 @@ jobs:
|
|||||||
format: 'cyclonedx-json'
|
format: 'cyclonedx-json'
|
||||||
output-file: 'sbom.cyclonedx.json'
|
output-file: 'sbom.cyclonedx.json'
|
||||||
- name: Attest
|
- name: Attest
|
||||||
uses: actions/attest-sbom@v2
|
uses: actions/attest-sbom@v3
|
||||||
id: attest
|
id: attest
|
||||||
with:
|
with:
|
||||||
subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import * as main from '../src/main'
|
|||||||
const runMock = jest.spyOn(main, 'run').mockImplementation()
|
const runMock = jest.spyOn(main, 'run').mockImplementation()
|
||||||
|
|
||||||
describe('index', () => {
|
describe('index', () => {
|
||||||
it('calls run when imported', async () => {
|
it('calls run when imported', () => {
|
||||||
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
||||||
require('../src/index')
|
require('../src/index')
|
||||||
|
|
||||||
|
|||||||
@@ -108,6 +108,13 @@ describe('generateSBOMPredicate', () => {
|
|||||||
expect(result.params).toEqual(sbom.object)
|
expect(result.params).toEqual(sbom.object)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('throws an error for missing SPDX version', () => {
|
||||||
|
const sbom = { type: 'spdx' } as SBOM
|
||||||
|
expect(() => generateSBOMPredicate(sbom)).toThrow(
|
||||||
|
'Cannot find spdxVersion in the SBOM'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
it('generates CycloneDX predicate correctly', () => {
|
it('generates CycloneDX predicate correctly', () => {
|
||||||
const sbom = { type: 'cyclonedx', object: {} } as SBOM
|
const sbom = { type: 'cyclonedx', object: {} } as SBOM
|
||||||
const result = generateSBOMPredicate(sbom)
|
const result = generateSBOMPredicate(sbom)
|
||||||
@@ -116,10 +123,8 @@ describe('generateSBOMPredicate', () => {
|
|||||||
})
|
})
|
||||||
|
|
||||||
it('throws error for unsupported SBOM formats', () => {
|
it('throws error for unsupported SBOM formats', () => {
|
||||||
const sbom = { type: 'spdx', object: {} }
|
const sbom = { type: 'foo', object: {} }
|
||||||
// @ts-expect-error test error case
|
// @ts-expect-error test error case
|
||||||
expect(() => generateSBOMPredicate(sbom)).toThrow(
|
expect(() => generateSBOMPredicate(sbom)).toThrow('Unsupported SBOM format')
|
||||||
'Cannot find spdxVersion in the SBOM'
|
|
||||||
)
|
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|||||||
+24
-8
@@ -9,20 +9,26 @@ inputs:
|
|||||||
subject-path:
|
subject-path:
|
||||||
description: >
|
description: >
|
||||||
Path to the artifact serving as the subject of the attestation. Must
|
Path to the artifact serving as the subject of the attestation. Must
|
||||||
specify exactly one of "subject-path" or "subject-digest". May contain a
|
specify exactly one of "subject-path", "subject-digest", or
|
||||||
glob pattern or list of paths (total subject count cannot exceed 1024).
|
"subject-checksums". May contain a glob pattern or list of paths (total
|
||||||
|
subject count cannot exceed 1024).
|
||||||
required: false
|
required: false
|
||||||
subject-digest:
|
subject-digest:
|
||||||
description: >
|
description: >
|
||||||
SHA256 digest of the subject for the attestation. Must be in the form
|
SHA256 digest of the subject for the attestation. Must be in the form
|
||||||
"sha256:hex_digest" (e.g. "sha256:abc123..."). Must specify exactly one of
|
"sha256:hex_digest" (e.g. "sha256:abc123..."). Must specify exactly one of
|
||||||
"subject-path" or "subject-digest".
|
"subject-path", "subject-digest", or "subject-checksums".
|
||||||
required: false
|
required: false
|
||||||
subject-name:
|
subject-name:
|
||||||
description: >
|
description: >
|
||||||
Subject name as it should appear in the attestation. Required unless
|
Subject name as it should appear in the attestation. Required when
|
||||||
"subject-path" is specified, in which case it will be inferred from the
|
identifying the subject with the "subject-digest" input.
|
||||||
path.
|
subject-checksums:
|
||||||
|
description: >
|
||||||
|
Path to checksums file containing digest and name of subjects for
|
||||||
|
attestation. Must specify exactly one of "subject-path", "subject-digest",
|
||||||
|
or "subject-checksums".
|
||||||
|
required: false
|
||||||
sbom-path:
|
sbom-path:
|
||||||
description: >
|
description: >
|
||||||
Path to the JSON-formatted SBOM file to attest. File size cannot exceed
|
Path to the JSON-formatted SBOM file to attest. File size cannot exceed
|
||||||
@@ -35,6 +41,12 @@ inputs:
|
|||||||
and that the "subject-digest" parameter be specified. Defaults to false.
|
and that the "subject-digest" parameter be specified. Defaults to false.
|
||||||
default: false
|
default: false
|
||||||
required: false
|
required: false
|
||||||
|
create-storage-record:
|
||||||
|
description: >
|
||||||
|
Whether to create a storage record for the artifact.
|
||||||
|
Requires that push-to-registry is set to true. Defaults to true.
|
||||||
|
default: true
|
||||||
|
required: false
|
||||||
show-summary:
|
show-summary:
|
||||||
description: >
|
description: >
|
||||||
Whether to attach a list of generated attestations to the workflow run
|
Whether to attach a list of generated attestations to the workflow run
|
||||||
@@ -61,20 +73,24 @@ outputs:
|
|||||||
runs:
|
runs:
|
||||||
using: 'composite'
|
using: 'composite'
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/attest-sbom/predicate@534423496eab34674190bc45fdacbb8b1198e07f # predicate@1.0.0
|
- uses: actions/attest-sbom/predicate@55e972012fb8695c1b0049174547f1fcb4baa8a5 # predicate@2.0.0
|
||||||
id: generate-sbom-predicate
|
id: generate-sbom-predicate
|
||||||
with:
|
with:
|
||||||
sbom-path: ${{ inputs.sbom-path }}
|
sbom-path: ${{ inputs.sbom-path }}
|
||||||
- uses: actions/attest@v2.1.0
|
- uses: actions/attest@7667f588f2f73a90cea6c7ac70e78266c4f76616 # v3.1.0
|
||||||
id: attest
|
id: attest
|
||||||
|
env:
|
||||||
|
NODE_OPTIONS: '--max-http-header-size=32768'
|
||||||
with:
|
with:
|
||||||
subject-path: ${{ inputs.subject-path }}
|
subject-path: ${{ inputs.subject-path }}
|
||||||
subject-digest: ${{ inputs.subject-digest }}
|
subject-digest: ${{ inputs.subject-digest }}
|
||||||
subject-name: ${{ inputs.subject-name }}
|
subject-name: ${{ inputs.subject-name }}
|
||||||
|
subject-checksums: ${{ inputs.subject-checksums }}
|
||||||
predicate-type:
|
predicate-type:
|
||||||
${{ steps.generate-sbom-predicate.outputs.predicate-type }}
|
${{ steps.generate-sbom-predicate.outputs.predicate-type }}
|
||||||
predicate-path:
|
predicate-path:
|
||||||
${{ steps.generate-sbom-predicate.outputs.predicate-path }}
|
${{ steps.generate-sbom-predicate.outputs.predicate-path }}
|
||||||
push-to-registry: ${{ inputs.push-to-registry }}
|
push-to-registry: ${{ inputs.push-to-registry }}
|
||||||
|
create-storage-record: ${{ inputs.create-storage-record }}
|
||||||
show-summary: ${{ inputs.show-summary }}
|
show-summary: ${{ inputs.show-summary }}
|
||||||
github-token: ${{ inputs.github-token }}
|
github-token: ${{ inputs.github-token }}
|
||||||
|
|||||||
+1268
-1010
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,92 @@
|
|||||||
|
import eslint from '@eslint/js'
|
||||||
|
import importplugin from 'eslint-plugin-import'
|
||||||
|
import jestplugin from 'eslint-plugin-jest'
|
||||||
|
import tseslint from 'typescript-eslint'
|
||||||
|
|
||||||
|
export default tseslint.config(
|
||||||
|
// Ignore non-project files
|
||||||
|
{
|
||||||
|
name: 'ignore',
|
||||||
|
ignores: ['.github', 'dist', 'coverage', '**/*.json', 'jest.setup.js', 'eslint.config.mjs']
|
||||||
|
},
|
||||||
|
// Use recommended rules from ESLint, TypeScript, and other plugins
|
||||||
|
eslint.configs.recommended,
|
||||||
|
tseslint.configs.recommendedTypeChecked,
|
||||||
|
jestplugin.configs['flat/recommended'],
|
||||||
|
importplugin.flatConfigs.recommended,
|
||||||
|
importplugin.flatConfigs.typescript,
|
||||||
|
// Override some rules
|
||||||
|
{
|
||||||
|
name: 'project-settings',
|
||||||
|
languageOptions: {
|
||||||
|
ecmaVersion: 2023,
|
||||||
|
parserOptions: {
|
||||||
|
project: ['./tsconfig.lint.json']
|
||||||
|
}
|
||||||
|
},
|
||||||
|
rules: {
|
||||||
|
// eslint rules
|
||||||
|
eqeqeq: ['error', 'smart'],
|
||||||
|
'func-style': ['error', 'declaration', { allowArrowFunctions: true }],
|
||||||
|
'no-console': 'off',
|
||||||
|
'no-implicit-globals': 'error',
|
||||||
|
'no-inner-declarations': 'error',
|
||||||
|
'no-invalid-this': 'error',
|
||||||
|
'no-return-assign': 'error',
|
||||||
|
'no-sequences': 'error',
|
||||||
|
'no-shadow': 'error',
|
||||||
|
'no-useless-concat': 'error',
|
||||||
|
'object-shorthand': ['error', 'always', { avoidQuotes: true }],
|
||||||
|
'one-var': ['error', 'never'],
|
||||||
|
'prefer-template': 'error',
|
||||||
|
|
||||||
|
// typescript-eslint rules
|
||||||
|
'@typescript-eslint/array-type': 'error',
|
||||||
|
'@typescript-eslint/consistent-type-assertions': 'error',
|
||||||
|
'@typescript-eslint/explicit-function-return-type': [
|
||||||
|
'error',
|
||||||
|
{ allowExpressions: true }
|
||||||
|
],
|
||||||
|
'@typescript-eslint/explicit-member-accessibility': [
|
||||||
|
'error',
|
||||||
|
{ accessibility: 'no-public' }
|
||||||
|
],
|
||||||
|
'@typescript-eslint/no-extraneous-class': 'error',
|
||||||
|
'@typescript-eslint/no-inferrable-types': 'error',
|
||||||
|
'@typescript-eslint/no-non-null-assertion': 'warn',
|
||||||
|
'@typescript-eslint/no-unnecessary-qualifier': 'error',
|
||||||
|
'@typescript-eslint/no-unsafe-assignment': 'off',
|
||||||
|
'@typescript-eslint/no-useless-constructor': 'error',
|
||||||
|
'@typescript-eslint/prefer-for-of': 'warn',
|
||||||
|
'@typescript-eslint/prefer-function-type': 'warn',
|
||||||
|
'@typescript-eslint/prefer-includes': 'error',
|
||||||
|
'@typescript-eslint/prefer-string-starts-ends-with': 'error',
|
||||||
|
'@typescript-eslint/promise-function-async': 'error',
|
||||||
|
'@typescript-eslint/require-array-sort-compare': 'error',
|
||||||
|
'@typescript-eslint/restrict-template-expressions': 'off',
|
||||||
|
|
||||||
|
// eslint-plugin-import rules
|
||||||
|
'import/extensions': 'error',
|
||||||
|
'import/first': 'error',
|
||||||
|
'import/no-absolute-path': 'error',
|
||||||
|
'import/no-commonjs': 'error',
|
||||||
|
'import/no-deprecated': 'warn',
|
||||||
|
'import/no-dynamic-require': 'error',
|
||||||
|
'import/no-extraneous-dependencies': 'error',
|
||||||
|
'import/no-mutable-exports': 'error',
|
||||||
|
'import/no-namespace': 'off',
|
||||||
|
'import/no-unresolved': ['error', { ignore: ['csv-parse/sync'] }],
|
||||||
|
'import/no-anonymous-default-export': [
|
||||||
|
'error',
|
||||||
|
{
|
||||||
|
allowAnonymousClass: false,
|
||||||
|
allowAnonymousFunction: false,
|
||||||
|
allowArray: true,
|
||||||
|
allowArrowFunction: false,
|
||||||
|
allowLiteral: true,
|
||||||
|
allowObject: true
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
Generated
+4213
-4094
File diff suppressed because it is too large
Load Diff
+19
-22
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "actions/attest-sbom",
|
"name": "actions/attest-sbom",
|
||||||
"description": "Generate signed SBOM attestations",
|
"description": "Generate signed SBOM attestations",
|
||||||
"version": "1.0.0",
|
"version": "2.0.0",
|
||||||
"author": "",
|
"author": "",
|
||||||
"private": true,
|
"private": true,
|
||||||
"homepage": "https://github.com/actions/attest-sbom",
|
"homepage": "https://github.com/actions/attest-sbom",
|
||||||
@@ -21,15 +21,15 @@
|
|||||||
".": "./dist/index.js"
|
".": "./dist/index.js"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=20"
|
"node": ">=24"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"bundle": "npm run format:write && npm run package",
|
"bundle": "npm run format:write && npm run package",
|
||||||
"ci-test": "jest",
|
"ci-test": "jest",
|
||||||
"format:write": "prettier --write **/*.ts",
|
"format:write": "prettier --write **/*.ts",
|
||||||
"format:check": "prettier --check **/*.ts",
|
"format:check": "prettier --check **/*.ts",
|
||||||
"lint:eslint": "npx eslint . -c ./.github/linters/.eslintrc.yml",
|
"lint:eslint": "npx eslint",
|
||||||
"lint:markdown": "npx markdownlint --config .github/linters/.markdown-lint.yml \"*.md\"",
|
"lint:markdown": "npx markdownlint --config .markdown-lint.yml \"*.md\"",
|
||||||
"lint": "npm run lint:eslint && npm run lint:markdown",
|
"lint": "npm run lint:eslint && npm run lint:markdown",
|
||||||
"package": "ncc build src/index.ts --license licenses.txt",
|
"package": "ncc build src/index.ts --license licenses.txt",
|
||||||
"package:watch": "npm run package -- --watch",
|
"package:watch": "npm run package -- --watch",
|
||||||
@@ -70,25 +70,22 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/core": "^1.11.1"
|
"@actions/core": "^2.0.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@actions/attest": "^1.5.0",
|
"@actions/attest": "^2.1.0",
|
||||||
"@types/jest": "^29.5.14",
|
"@eslint/js": "^9.39.2",
|
||||||
"@types/node": "^22.10.1",
|
"@types/jest": "^30.0.0",
|
||||||
"@typescript-eslint/eslint-plugin": "^7.17.0",
|
"@types/node": "^25.0.2",
|
||||||
"@typescript-eslint/parser": "^7.18.0",
|
"@vercel/ncc": "^0.38.4",
|
||||||
"@vercel/ncc": "^0.38.3",
|
"eslint": "^9.39.2",
|
||||||
"eslint": "^8.57.1",
|
"eslint-plugin-import": "^2.32.0",
|
||||||
"eslint-plugin-github": "^5.1.4",
|
"eslint-plugin-jest": "^29.5.0",
|
||||||
"eslint-plugin-jest": "^28.9.0",
|
"jest": "^30.2.0",
|
||||||
"eslint-plugin-jsonc": "^2.18.2",
|
"markdownlint-cli": "^0.47.0",
|
||||||
"eslint-plugin-prettier": "^5.2.1",
|
"prettier": "^3.7.4",
|
||||||
"jest": "^29.7.0",
|
"ts-jest": "^29.4.6",
|
||||||
"markdownlint-cli": "^0.43.0",
|
"typescript": "^5.9.3",
|
||||||
"prettier": "^3.4.2",
|
"typescript-eslint": "^8.49.0"
|
||||||
"prettier-eslint": "^16.3.0",
|
|
||||||
"ts-jest": "^29.2.5",
|
|
||||||
"typescript": "^5.7.2"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,5 +15,5 @@ outputs:
|
|||||||
description: >
|
description: >
|
||||||
URI identifying the type of the predicate.
|
URI identifying the type of the predicate.
|
||||||
runs:
|
runs:
|
||||||
using: node20
|
using: node24
|
||||||
main: ../dist/index.js
|
main: ../dist/index.js
|
||||||
|
|||||||
+6
-5
@@ -12,7 +12,7 @@ export async function parseSBOMFromPath(filePath: string): Promise<SBOM> {
|
|||||||
// Read the file content
|
// Read the file content
|
||||||
const fileContent = await fs.promises.readFile(filePath, 'utf8')
|
const fileContent = await fs.promises.readFile(filePath, 'utf8')
|
||||||
|
|
||||||
const sbom = JSON.parse(fileContent)
|
const sbom = JSON.parse(fileContent) as object
|
||||||
|
|
||||||
if (checkIsSPDX(sbom)) {
|
if (checkIsSPDX(sbom)) {
|
||||||
return { type: 'spdx', object: sbom }
|
return { type: 'spdx', object: sbom }
|
||||||
@@ -66,14 +66,15 @@ export const storePredicate = (predicate: Predicate): string => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export const generateSBOMPredicate = (sbom: SBOM): Predicate => {
|
export const generateSBOMPredicate = (sbom: SBOM): Predicate => {
|
||||||
if (sbom.type === 'spdx') {
|
switch (sbom.type) {
|
||||||
|
case 'spdx':
|
||||||
return generateSPDXIntoto(sbom.object)
|
return generateSPDXIntoto(sbom.object)
|
||||||
}
|
case 'cyclonedx':
|
||||||
if (sbom.type === 'cyclonedx') {
|
|
||||||
return generateCycloneDXIntoto(sbom.object)
|
return generateCycloneDXIntoto(sbom.object)
|
||||||
}
|
default:
|
||||||
throw new Error('Unsupported SBOM format')
|
throw new Error('Unsupported SBOM format')
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// ref: https://github.com/in-toto/attestation/blob/main/spec/predicates/spdx.md
|
// ref: https://github.com/in-toto/attestation/blob/main/spec/predicates/spdx.md
|
||||||
const generateSPDXIntoto = (sbom: object): Predicate => {
|
const generateSPDXIntoto = (sbom: object): Predicate => {
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
"module": "NodeNext",
|
"module": "NodeNext",
|
||||||
"rootDir": "./src",
|
"rootDir": "./src",
|
||||||
"moduleResolution": "NodeNext",
|
"moduleResolution": "NodeNext",
|
||||||
|
"isolatedModules": true,
|
||||||
"baseUrl": "./",
|
"baseUrl": "./",
|
||||||
"sourceMap": true,
|
"sourceMap": true,
|
||||||
"outDir": "./dist",
|
"outDir": "./dist",
|
||||||
|
|||||||
@@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://json.schemastore.org/tsconfig",
|
||||||
|
"extends": "./tsconfig.json",
|
||||||
|
"compilerOptions": {
|
||||||
|
"noEmit": true
|
||||||
|
},
|
||||||
|
"include": ["./__tests__/**/*", "./src/**/*"],
|
||||||
|
"exclude": ["./dist", "./node_modules", "./coverage", "*.json"]
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user