Skip to content

Commit f6da9d1

Browse files
committed
update readme
1 parent 3ddd46a commit f6da9d1

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# ReversingLabs GitHub Action: rl-scanner-cloud-composite
22

3-
ReversingLabs provides officially supported GitHub Actions for a faster and easier way to integrate the [secure.software Portal](https://docs.secure.software/portal/) with CI/CD workflows.
3+
ReversingLabs provides officially supported GitHub Actions for a faster and easier way to integrate the [Spectra Assure Portal](https://docs.secure.software/portal/) with CI/CD workflows.
44

55
The `rl-scanner-cloud-composite` action uses the official [reversinglabs/rl-scanner-cloud](https://hub.docker.com/r/reversinglabs/rl-scanner-cloud)
66
Docker image to:
77

8-
- upload and scan a single build artifact on a secure.software Portal instance;
8+
- upload and scan a single build artifact on a Spectra Assure Portal instance;
99
- display the analysis status as one of the checks in the GitHub interface;
1010
- return the exit status message.
1111

@@ -17,12 +17,12 @@ Compared to `rl-scanner-cloud-only`, this action is more convenient out-of-the-b
1717
In the `rl-scanner-cloud-only` action, everything except the scan has to be provided by the user creating the workflow.
1818

1919

20-
## What is the secure.software Portal?
20+
## What is the Spectra Assure Portal?
2121

22-
The secure.software Portal is a SaaS solution that's part of the [secure.software platform](https://www.secure.software/) - a new ReversingLabs solution for software supply chain security.
22+
The Spectra Assure Portal is a SaaS solution that's part of the [Spectra Assure platform](https://www.reversinglabs.com/products/software-supply-chain-security) - a new ReversingLabs solution for software supply chain security.
2323
More specifically, the Portal is a web-based application for improving and managing the security of your software releases and verifying third-party software used in your organization.
2424

25-
With the secure.software Portal, you can:
25+
With the Spectra Assure Portal, you can:
2626

2727
- Scan your software packages to detect potential risks before release.
2828
- Improve your SDLC by applying actionable advice from security scan reports to all phases of software development.
@@ -54,7 +54,7 @@ When called, the action runs the following steps:
5454

5555
- Set the commit status to pending.
5656
- Pull the latest version of the `reversinglabs/rl-scanner-cloud` Docker image.
57-
- Connect to a secure.software Portal instance from the container and upload the artifact to the Portal for scanning.
57+
- Connect to a Spectra Assure Portal instance from the container and upload the artifact to the Portal for scanning.
5858
- Upload the analysis report to GitHub as `report-sha`, where `sha` corresponds to the SHA identifier of the commit or PR that triggered the action. This makes the report names unique and helps relate them to specific commits if necessary.
5959
- Upload the SARIF report file as `report.sarif.json` to the report directory.
6060
- Change the commit status from pending to success/failure depending on the scan result with a descriptive message.
@@ -63,8 +63,8 @@ When called, the action runs the following steps:
6363

6464
## Requirements
6565

66-
1. **An active secure.software Portal account and a Personal Access Token generated for it.** If you don't already have a Portal account, you may need to contact the administrator of your Portal organization to [invite you](https://docs.secure.software/portal/members#invite-a-new-member).
67-
Alternatively, if you're not a secure.software customer yet, you can [contact ReversingLabs](https://docs.secure.software/portal/#get-access-to-securesoftware-portal) to sign up for a Portal account.
66+
1. **An active Spectra Assure Portal account and a Personal Access Token generated for it.** If you don't already have a Portal account, you may need to contact the administrator of your Portal organization to [invite you](https://docs.secure.software/portal/members#invite-a-new-member).
67+
Alternatively, if you're not a Spectra Assure customer yet, you can [contact ReversingLabs](https://docs.secure.software/portal/#get-access-to-securesoftware-portal) to sign up for a Portal account.
6868
When you have an account set up, follow the instructions to [generate a Personal Access Token](https://docs.secure.software/api/generate-api-token).
6969

7070

@@ -75,13 +75,13 @@ contact your GitHub organization administrators for help.
7575

7676
## Environment variables
7777

78-
This action requires authentication to a secure.software Portal instance with a Personal Access Token.
78+
This action requires authentication to a Spectra Assure Portal instance with a Personal Access Token.
7979
The token must be passed via the environment using the following environment variables.
8080

8181

8282
| Environment variable | Description |
8383
| :--------- | :------ |
84-
| `RLPORTAL_ACCESS_TOKEN` | **Required.** A Personal Access Token for authenticating requests to the secure.software Portal. Before you can use this GitHub Action, you must [create the token](https://docs.secure.software/api/generate-api-token) in your Portal settings. Tokens can expire and be revoked, in which case you'll have to update the value of this environment variable. It's strongly recommended to treat this token as a secret and manage it according to your organization's security best practices. |
84+
| `RLPORTAL_ACCESS_TOKEN` | **Required.** A Personal Access Token for authenticating requests to the Spectra Assure Portal. Before you can use this GitHub Action, you must [create the token](https://docs.secure.software/api/generate-api-token) in your Portal settings. Tokens can expire and be revoked, in which case you'll have to update the value of this environment variable. It's strongly recommended to treat this token as a secret and manage it according to your organization's security best practices. |
8585

8686

8787
ReversingLabs strongly recommends [defining secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#using-encrypted-secrets-in-a-workflow) on the level of your GitHub organization or repository.
@@ -100,16 +100,16 @@ To compare a new version of an artifact against a previously scanned version, yo
100100
Both versions must be in the same Portal project and package.
101101
This comparison is also known as the **diff scan**.
102102

103-
To perform the diff scan, specify the package URL (PURL) of the previously scanned version with the `rl-diff-with` parameter.
104-
The action will verify that the requested artifact version was actually scanned before on the Portal, and ignore the request for a diff scan if there are no results for the requested PURL.
103+
To perform the diff scan, specify the package URL (purl) of the previously scanned version with the `rl-diff-with` parameter.
104+
The action will verify that the requested artifact version was actually scanned before on the Portal, and ignore the request for a diff scan if there are no results for the requested package URL.
105105

106106
After a successful diff scan, the analysis report of the new artifact version will contain the Diff tab with all the differences between the two versions.
107107
In the Portal web interface, the new version will be marked as "Derived" from the previous version.
108108

109109

110110
## Optional proxy configuration
111111

112-
In some cases, proxy configuration may be required to access the internet and connect to a secure.software Portal instance.
112+
In some cases, proxy configuration may be required to access the internet and connect to a Spectra Assure Portal instance.
113113
You can configure proxy settings with the `rl-proxy-*` parameters for any self-hosted runner, including local GitHub Enterprise setups.
114114

115115
When using the `rl-proxy-server` parameter, you must also specify the port with `rl-proxy-port`.
@@ -121,11 +121,11 @@ If the proxy requires authentication, the proxy credentials for authentication c
121121

122122
| Input parameter | Required | Description |
123123
| :--------- | :------ | :------ |
124-
| `artifact-to-scan` | **Yes** | The build artifact you want to scan. Provide the artifact file path relative to the `github.workspace`. The file must be in any of the [formats supported by secure.software](https://docs.secure.software/concepts/reference). The file size on disk must not exceed 10 GB. |
125-
| `rl-portal-server` | **Yes** | Name of the secure.software Portal instance to use for the scan. The Portal instance name usually matches the subdirectory of `my.secure.software` in your Portal URL. For example, if your portal URL is `my.secure.software/demo`, the instance name to use with this parameter is `demo`. |
126-
| `rl-portal-org` | **Yes** | The name of a secure.software Portal organization to use for the scan. The organization must exist on the Portal instance specified with `rl-portal-server`. The user account authenticated with the token must be a member of the specified organization and have the appropriate permissions to upload and scan a file. Organization names are case-sensitive. |
127-
| `rl-portal-group` | **Yes** | The name of a secure.software Portal group to use for the scan. The group must exist in the Portal organization specified with `rl-portal-org`. Group names are case-sensitive. |
128-
| `rl-package-url` | **Yes** | The package URL (PURL) used to associate the build artifact with a project and package on the Portal. PURLs are unique identifiers in the format `<project></package><@version>`. When scanning a build artifact, you must assign a PURL to it, so that it can be placed into the specified project and package as a version. If the project and package you specified don't exist in the Portal, they will be automatically created. |
124+
| `artifact-to-scan` | **Yes** | The build artifact you want to scan. Provide the artifact file path relative to the `github.workspace`. The file must be in any of the [formats supported by Spectra Assure](https://docs.secure.software/concepts/reference). The file size on disk must not exceed 10 GB. |
125+
| `rl-portal-server` | **Yes** | Name of the Spectra Assure Portal instance to use for the scan. The Portal instance name usually matches the subdirectory of `my.secure.software` in your Portal URL. For example, if your portal URL is `my.secure.software/demo`, the instance name to use with this parameter is `demo`. |
126+
| `rl-portal-org` | **Yes** | Name of the Spectra Assure Portal organization to use for the scan. The organization must exist on the Portal instance specified with `rl-portal-server`. The user account authenticated with the token must be a member of the specified organization and have the appropriate permissions to upload and scan a file. Organization names are case-sensitive. |
127+
| `rl-portal-group` | **Yes** | Name of the Spectra Assure Portal group to use for the scan. The group must exist in the Portal organization specified with `rl-portal-org`. Group names are case-sensitive. |
128+
| `rl-package-url` | **Yes** | The package URL (purl) used to associate the build artifact with a project and package on the Portal. Package URLs are unique identifiers in the format `<project></package><@version>`. When scanning a build artifact, you must assign a package URL to it, so that it can be placed into the specified project and package as a version. If the project and package you specified don't exist in the Portal, they will be automatically created. |
129129
`report-path` | No | The directory where the action will store analysis reports for the build artifact. The directory must be empty. Provide the directory path relative to the `github.workspace`. Default value is `MyReportDir`. If you specify an empty string ("") as the value, report downloads will be disabled and no reports will be downloaded. |
130130
| `rl-diff-with` | No | This optional parameter lets you specify a previous version against which you want to compare (diff) the artifact version you're scanning. The specified version must exist in the same project and package as the artifact you're scanning. |
131131
| `rl-timeout` | No | This optional parameter lets you specify how long to wait for analysis to complete before failing (in minutes). The parameter accepts any integer from 10 to 1440. The default timeout is 20 minutes. |
@@ -150,11 +150,11 @@ If the proxy requires authentication, the proxy credentials for authentication c
150150
The following example is a basic GitHub workflow that runs on pull requests (PRs) and commit pushes to the `main` branch in your repository.
151151

152152
The workflow checks out your repository, builds an artifact,
153-
and uses the `rl-scanner-cloud-composite` GitHub action to scan the artifact on the secure.software Portal.
153+
and uses the `rl-scanner-cloud-composite` GitHub action to scan the artifact on the Spectra Assure Portal.
154154

155155
When the scan is done, the GitHub status is updated.
156156

157-
Portal users can then view the analysis report and [manage the analyzed file](https://docs.secure.software/portal/projects#work-with-package-versions-releases) from the Portal web interface or via the Portal Public APIs like any other package version.
157+
Portal users can then view the analysis report and [manage the analyzed file](https://docs.secure.software/portal/projects#work-with-package-versions-releases) from the Portal web interface or via the Portal APIs like any other package version.
158158

159159

160160
name: ReversingLabs rl-scanner-cloud
@@ -218,7 +218,7 @@ Portal users can then view the analysis report and [manage the analyzed file](ht
218218
# Useful resources
219219

220220
- The official `reversinglabs/rl-scanner-cloud` Docker image [on Docker Hub](https://hub.docker.com/r/reversinglabs/rl-scanner-cloud)
221-
- The official [secure.software Portal documentation](https://docs.secure.software/portal/)
221+
- The official [Spectra Assure Portal documentation](https://docs.secure.software/portal/)
222222
- The [rl-scanner-cloud-only](https://github.com/reversinglabs/gh-action-rl-scanner-cloud-only) GitHub Action
223223
- Introduction to [secure software release processes](https://www.reversinglabs.com/solutions/secure-software-release-processes) with ReversingLabs
224224

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: 'gh-action-rl-scanner-cloud-composite'
22
author: 'ReversingLabs'
3-
description: 'Scan an artifact with ReversingLabs secure.software Portal'
3+
description: 'Scan an artifact with ReversingLabs Spectra Assure Portal'
44

55
branding:
66
icon: 'shield'
@@ -138,7 +138,7 @@ runs:
138138
path: "${{ inputs.report-path }}"
139139

140140
# -------------------------------------
141-
# Upload the secure.software SARIF report to GitHub
141+
# Upload the Spectra Assure SARIF report to GitHub
142142
- name: Upload the SARIF report
143143
if: success() || failure()
144144
uses: github/codeql-action/upload-sarif@379614612a29c9e28f31f39a59013eb8012a51f0 # v3

0 commit comments

Comments
 (0)