trendmicro/tmas-scan
Scan an artifact for open source vulnerabilities, secrets, and malware using the TMAS (TrendAI Artifact Scanner) CLI.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| version | Version of the TMAS CLI you would like to use (eg. 2.100.0, '2' for latest v2.x.x, or 'latest'). Specifying the 'latest' TMAS version might cause the action to fail if there is a new major TMAS version released with a breaking change. | no | latest |
| path | TMAS will be installed in the "<path>/tmas-bin" directory, and then added to $GITHUB_PATH. | no | $GITHUB_WORKSPACE/.local/bin |
| cache | Used to specify whether you would like to cache the TMAS CLI binary. Set to false, if you would like to disable caching. | no | true |
| vulnerabilitiesScan | Enable scanning for open source vulnerabilities. At least one of the scanners must be enabled. | no | false |
| malwareScan | Enable scanning for malware. The supported artifact types are [registry docker docker-archive oci-archive oci-dir artifacts]. At least one of the scanners must be enabled. | no | false |
| secretsScan | Enable scanning for secrets. At least one of the scanners must be enabled. | no | false |
| artifact | Artifact to scan, refer to the list of [supported artifacts](https://docs.trendmicro.com/en-us/documentation/article/trend-vision-one-artifactscannerclire#GUID-09957805-70E7-401F-A691-F587FCE2CB8B-u88cv4__supportedArtifacts) | yes | — |
| additionalArgs | Any additional arguments for the TMAS cli can be specified here (ie. --saveSBOM). Available optional scan arguments can be found [here](https://docs.trendmicro.com/en-us/documentation/article/trend-vision-one-artifactscannerclire#GUID-09957805-70E7-401F-A691-F587FCE2CB8B-u88cv4__scanCommandFlags). | no | "" |
| tmasApiKey | TrendAI Vision One API Key that is associated with your TrendAI Vision One account, it is recommended to use a github secret for this parameter. For steps on how to obtain a TrendAI Vision One API Key, checkout the [setup documentation](https://docs.trendmicro.com/en-us/documentation/article/trend-vision-one-artifactsannerapikey#GUID-09957805-70E7-401F-A691-F587FCE2CB8B-chuby2). | yes | — |
| githubToken | GitHub token for authentication Github API. May use standard github actions token (secrets.GITHUB_TOKEN) or custom personal access token with repo scope. | yes | — |
| skipInstall | Skip the download and installation of TMAS. This assumes that the `tmas` command is already installed and added to the `PATH`. | no | false |
Outputs
no outputs