finitestateinc/Finite State Binary Scan
Upload a binary to the Finite State Platform to conduct a Quick Scan or full analysis.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| finite-state-client-id | Finitestate API client ID. | yes | — |
| finite-state-secret | Finitestate API secret. | yes | — |
| finite-state-organization-context | Organization context. This is provided by the Finite State API management. It looks like "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx". | yes | — |
| asset-id | Asset ID for the asset that the new asset version will belong to. | yes | — |
| version | The name of the asset version that will be created. | yes | — |
| file-path | Local path of the file to be uploaded. | yes | — |
| quick-scan | Boolean that uploads the file for quick scan when true. Defaults to true (Quick Scan). For details about the contents of the Quick Scan vs. the Full Scan, please see the API documentation. | yes | true |
| automatic-comment | Defaults to false. If it is true, it will generate a comment in the PR with the link to the Asset version URL in Finite State. | no | false |
| github-token | Token used to generate comment in a pr. Only required if automatic-comment input is true. | no | — |
| business-unit-id | (optional) ID of the business unit that the asset version will belong to. If not provided, the asset version will adopt the existing business unit of the asset. | no | — |
| created-by-user-id | (optional) ID of the user to be recorded as the "Created By User" on the asset version. If not provided, the version will adopt the existing value of the asset. | no | — |
| product-id | (optional) ID of the product that the asset version will belong to. If not provided, the existing product for the asset will be used, if applicable. | no | — |
| artifact-description | (optional) Description of the artifact. If not provided, the default is "Firmware Binary". | no | — |
Outputs
| name | description |
|---|---|
| response | Response from Finite State servers. |
| error | Error message or details on why the action fails, if applicable. |
| asset-version-url | Finite State binary analysis URL for the file uploaded. |