Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ $ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.


### Build

```
Expand Down
4 changes: 2 additions & 2 deletions docs/integrating-scribe/ci-integrations/github/action-bom.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,15 +169,15 @@ To overcome the limitation install tool directly - **[installer](https://github.
Containerized action can be used on Linux runners as following
```yaml
- name: Generate cyclonedx json SBOM
uses: scribe-security/action-bom@v1.5.10
uses: scribe-security/action-bom@v1.5.11
with:
target: 'busybox:latest'
```

Composite Action can be used on Linux or Windows runners as following
```yaml
- name: Generate cyclonedx json SBOM
uses: scribe-security/action-bom-cli@v1.5.10
uses: scribe-security/action-bom-cli@v1.5.11
with:
target: 'hello-world:latest'
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,15 +136,15 @@ The `valint evidence` action is a versatile action designed to include various t
Containerized action can be used on Linux runners as following
```yaml
- name: Include evidence derived from a file
uses: scribe-security/action-evidence@v1.5.10
uses: scribe-security/action-evidence@v1.5.11
with:
target: some_file.json
```

Composite Action can be used on Linux or Windows runners as following
```yaml
- name: Include evidence derived from a file
uses: scribe-security/action-evidence-cli@v1.5.10
uses: scribe-security/action-evidence-cli@v1.5.11
with:
target: some_file.json
```
Expand Down
4 changes: 2 additions & 2 deletions docs/integrating-scribe/ci-integrations/github/action-slsa.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,15 +155,15 @@ To overcome the limitation install tool directly - [installer](https://github.co
Containerized action can be used on Linux runners as following
```yaml
- name: Generate SLSA provenance
uses: scribe-security/action-slsa@v1.5.10
uses: scribe-security/action-slsa@v1.5.11
with:
target: 'busybox:latest'
```

Composite Action can be used on Linux or Windows runners as following
```yaml
- name: Generate cyclonedx json SBOM
uses: scribe-security/action-slsa-cli@v1.5.10
uses: scribe-security/action-slsa-cli@v1.5.11
with:
target: 'hello-world:latest'
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ The command allows users to verify any target against its evidence.
description: Default policy allowed emails
force:
description: Force skip cache
format:
description: Policy Result Evidence format, options=[statement-sarif attest-sarif sarif ]
git-auth:
description: 'Git repository authentication info, [format: ''username:password'']'
git-branch:
Expand All @@ -74,7 +76,7 @@ The command allows users to verify any target against its evidence.
initiative:
description: Run only rules with specified initiative
input-format:
description: Evidence format, options=[attest-cyclonedx-json attest-slsa statement-slsa statement-cyclonedx-json statement-generic attest-generic ]
description: Input Evidence format, options=[attest-cyclonedx-json attest-slsa statement-slsa statement-cyclonedx-json statement-generic attest-generic ]
key:
description: x509 Private key path
kms:
Expand Down Expand Up @@ -161,15 +163,15 @@ Containerized action can be used on Linux runners as following
```yaml
- name: valint verify
id: valint_verify
uses: scribe-security/action-verify@v1.5.10
uses: scribe-security/action-verify@v1.5.11
with:
target: 'busybox:latest'
```

Composite Action can be used on Linux or Windows runners as following
```yaml
- name: Generate cyclonedx json SBOM
uses: scribe-security/action-verify-cli@v1.5.10
uses: scribe-security/action-verify-cli@v1.5.11
with:
target: 'hello-world:latest'
```
Expand Down
21 changes: 11 additions & 10 deletions docs/platforms/bom.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ options:
--valint.sign sign evidence (default: False)
--valint.components COMPONENTS
components list (type: str, default: )
--valint.label LABEL Set additional labels (type: <function <lambda> at 0x7f98996193a0>, default: [])
--valint.label LABEL Set additional labels (type: <function <lambda> at 0x7fb5d78c6480>, default: [])
--unique Allow unique assets (default: False)

subcommands:
Expand Down Expand Up @@ -148,12 +148,12 @@ Note that the image characterization string is a wildcarded string, some useful
usage: platforms [options] bom [options] dockerhub [-h] [--instance INSTANCE]
[--default_product_key_strategy {namespace,repository,tag,mapping}]
[--default_product_version_strategy {tag,short_image_id,image_id}]
[--scope.namespace [NAMESPACE ...]] [--scope.repository [REPOSITORY ...]]
[--scope.repository [REPOSITORY ...]]
[--scope.repository_tags [REPOSITORY_TAGS ...]]
[--scope.image_platform [IMAGE_PLATFORM ...]]
[--exclude.repository [REPOSITORY ...]]
[--exclude.repository_tags [REPOSITORY_TAGS ...]]
[--image.mapping [MAPPING ...]]
[--scope.namespace [NAMESPACE ...]] [--image.mapping [MAPPING ...]]

options:
-h, --help Show this help message and exit.
Expand All @@ -162,8 +162,6 @@ options:
Override product key with namespace, repository or image names (default: mapping)
--default_product_version_strategy {tag,short_image_id,image_id}
Override product version with tag or image id (default: short_image_id)
--scope.namespace [NAMESPACE ...]
Dockerhub namespaces (default: ['*'])
--scope.repository [REPOSITORY ...]
Dockerhub repositories (default: ['*'])
--scope.repository_tags [REPOSITORY_TAGS ...]
Expand All @@ -174,6 +172,8 @@ options:
Dockerhub repository wildcards to exclude (default: [])
--exclude.repository_tags [REPOSITORY_TAGS ...]
Dockerhub tags to exclude (default: [])
--scope.namespace [NAMESPACE ...]
Dockerhub namespaces (default: ['*'])
--image.mapping [MAPPING ...]
Image product key mapping in the format of asset::product_key::product_version (type:
AssetMappingString, default: [])
Expand Down Expand Up @@ -410,7 +410,7 @@ Note that the image characterization string is a wildcarded string, some useful
```bash
usage: platforms [options] bom [options] bitbucket [-h] [--instance INSTANCE] [--app_password APP_PASSWORD]
[--username USERNAME] [--workspace_token WORKSPACE_TOKEN]
[--workspace_name WORKSPACE_NAME] [--types {repository,all}]
[--workspace_name WORKSPACE_NAME] --url URL [--types {repository,all}]
[--scope.workspace [WORKSPACE ...]] [--scope.project [PROJECT ...]]
[--scope.repository [REPOSITORY ...]] [--scope.commit [COMMIT ...]]
[--scope.branch [BRANCH ...]] [--scope.webhook [WEBHOOK ...]]
Expand All @@ -422,14 +422,15 @@ options:
-h, --help Show this help message and exit.
--instance INSTANCE BitBucket instance string (default: )
--app_password APP_PASSWORD
BitBucket app_password (default: null)
BitBucket app_password (BB_PASSWORD) (default: )
--username USERNAME BitBucket username (default: null)
--workspace_token WORKSPACE_TOKEN
BitBucket workspace_token can be used with --workspace_name flag instead of --app_password and
--username (default: null)
--username (BB_WORKSPACE_TOKEN) (default: )
--workspace_name WORKSPACE_NAME
BitBucket workspace_name can be used with --workspace_token flag instead of --app_password and
--username (default: null)
--url URL BitBucket URL (required)
--types {repository,all}
Specifies the type of evidence to generate, scoped by scope parameters (default: repository)
--scope.workspace [WORKSPACE ...]
Expand Down Expand Up @@ -491,7 +492,7 @@ usage: platforms [options] bom [options] github [-h] [--instance INSTANCE] [--to
options:
-h, --help Show this help message and exit.
--instance INSTANCE Github instance string (default: )
--token TOKEN Github token (required, default: )
--token TOKEN Github token (GITHUB_TOKEN, GH_TOKEN) (default: )
--url URL Github base URL (default: https://github.com)
--types {repository,all}
Specifies the type of evidence to generate, scoped by scope parameters (default: repository)
Expand Down Expand Up @@ -548,7 +549,7 @@ usage: platforms [options] bom [options] gitlab [-h] [--instance INSTANCE] [--to
options:
-h, --help Show this help message and exit.
--instance INSTANCE Gitlab instance string (default: )
--token TOKEN Gitlab token (required, default: )
--token TOKEN Gitlab token (GITLAB_TOKEN, CI_JOB_TOKEN) (default: )
--url URL Gitlab base URL (default: https://gitlab.com/)
--types {project,all}
Specifies the type of evidence to generate, scoped by scope parameters (default: all)
Expand Down
Loading