edgescan/cicd-integration

By edgescan

•Updated over 2 years ago

This image allows to kick off an assessment on Edgescan and fails/succeeds according to its result.

Image

2.0K

Overview Tags

edgescan/cicd-integration repository overview

⁠Edgescan CI/CD integration

This image allows the user to:

Kick off an assessment and fails/succeeds according to its result.

It succeeds if the assessment completes with no vulnerabilities found (a tolerance for the risk level can be provided), it fails otherwise.

When it's not waiting for the scan to finish it succeeds once the assessment is started.

The program will exit with value 0 on success and -1 otherwise.
Create a new asset. Optionally:
- Add locations.
- Assign licence.
- Kick off assessment on the new asset as in step 1.

⁠Getting started

Fetch the latest Docker image

docker pull edgescan/cicd-integration:latest

Execute the Docker image and append --help for details about its usage

docker run --tty edgescan/cicd-integration --help

Configuration can be provided in 3 ways (in order of priority)

1. CLI flags
2. YAML configuration file
3. Environment variables

Parameter	Command line flag	Field name in configuration file	Environment variable name	Default value	Required
Shared Options
API Token	--api-token	api_token	ES_API_TOKEN	None	True
Base URL	--base-url	base_url	ES_BASE_URL	"https://live.edgescan.com⁠"	False
Color	--color / --no-color	color	COLOR	True	False
Proxy	--proxy	proxy	PROXY	None	False
Fail on Open Vulns	--fail-on-vulns / --pass-on-vulns	fail_on_vulns	FAIL_ON_VULNS	True	False
Scanning Options
Start scanning	--start-scan	start_scan	START_SCAN	None	True
Asset ID	--asset-id	asset_id	ES_ASSET_ID	None	True
Max Risk Threshold	--max-risk-threshold	max_risk_threshold	MAX_RISK_THRESHOLD	3	False
Wait	--wait / --no-wait	wait	WAIT	True	False
New Asset Options
Create asset	--create-asset	create_asset	CREATE_ASSET	None	True
Asset Name	--name	name	NAME	None	True
Asset Type	--type	type	TYPE	None ("app" or "net")	True
New Locations	--locations	locations	LOCATIONS	None	False
Licence Name	--licence-name	licence_name	LICENCE_NAME	None	False
Order ID	--order-id	order_id	ORDER_ID	None	False
Licence UUID	--licence-uuid	licence_uuid	LICENCE_UUID	None	False

⁠Execute the Docker image

Executing with the command line interface

docker run --tty edgescan/cicd-integration --start-scan --asset-id 1234 --api-token th34p1t0ken

Executing with a YAML config file

docker run --tty -v /local/path/to/file.yml:/cicd-config.yml edgescan/cicd-integration

Executing with an environment variable file

docker run --tty --env-file .env edgescan/cicd-integration

Executing with all 3 methods

docker run --tty -v /path/to/file.yml:/cicd-config.yml --env-file .env edgescan/cicd-integration --asset-id 1234

⁠Execution Examples using the CLI

⁠Start scan on an asset, and wait for the results

docker run --tty edgescan/cicd-integration --api-token "4p1t0k3n|1234" --start-scan --asset-id 5678 --wait --max_risk_threshold 3

⁠Start scan on an asset, and do not wait for the results

docker run --tty edgescan/cicd-integration --api-token "4p1t0k3n|1234" --start-scan --asset-id 5678 --no-wait max_risk_threshold 3

⁠Create an asset, without locations, or a licence

docker run --tty edgescan/cicd-integration --api-token "4p1t0k3n|1234" ---create-asset --name "Test Asset" --type "app"

⁠Create an asset, with locations, and no licence

docker run --tty edgescan/cicd-integration --api-token "4p1t0k3n|1234" ---create-asset --name "Test Asset" --type "net" --locations "test.example.com,https://test.example.com"

⁠Create an asset, with locations, and a V2 licence

docker run --tty edgescan/cicd-integration --api-token "4p1t0k3n|1234" ---create-asset --name "Test Asset" --type "net" --locations "test.example.com,https://test.example.com" --licence_name "Licence Name" --order_id 123

⁠Create an asset, with locations, and a V3 licence

docker run --tty edgescan/cicd-integration --api-token "4p1t0k3n|1234" ---create-asset --name "Test Asset" --type "net" --locations "test.example.com,https://test.example.com" --licence_uuid "Licence UUID"

⁠Create an asset, with locations, and a V2 licence. Start a scan on the asset and do not wait for results

docker run --tty edgescan/cicd-integration --api-token "4p1t0k3n|1234" ---create-asset --name "Test Asset" --type "net" --locations "test.example.com" --licence_name "Licence Name" --order-id 123 --start-scan --no-wait

⁠Create an asset, with locations, and a V3 licence. Start a scan on the asset and do not wait for results

docker run --tty edgescan/cicd-integration --api-token "4p1t0k3n|1234" ---create-asset --name "Test Asset" --type "net" --locations "test.example.com" --licence_uuid "Licence UUID" --start-scan --no-wait

⁠Create an asset, with locations, and a V2 licence. Start a scan on another asset and wait for results

docker run --tty edgescan/cicd-integration --api-token "4p1t0k3n|1234" ---create-asset --name "Test Asset" --type "net" --locations "test.example.com" --licence_name "Licence Name" --order-id 123 --start-scan --asset-id 456 --wait

⁠Create an asset, with locations, and a V3 licence. Start a scan on another asset and wait for results

docker run --tty edgescan/cicd-integration --api-token "4p1t0k3n|1234" ---create-asset --name "Test Asset" --type "net" --locations "test.example.com" --licence_uuid "Licence UUID" --start-scan --asset-id 456 --wait

Tag summary

Recent tags

Content type

Image

Digest

sha256:c733097fc…

Size

340 MB

Last updated

over 2 years ago

docker pull edgescan/cicd-integration