Travis CI Integration Examples
This section provides the Travis CI integration examples for different use cases.
Example 1. Scan from the cloud using the Bright CLI (NPM installation)
You only need to install the Bright CLI globally on your Travis CI machine using the relative NPM command to apply this option.
Prerequisites
- You have a valid organization API key or personal API key (
BRIGHT_TOKEN
) with the following scopes:bot
,scans : run
,scan : read
, andscans : stop
. - You have created the
BRIGHT_TOKEN
variable on your Travis CI machine: more options > settings > add the environmental variable. - You have copied the Bright
PROJECT_ID
on the Projects page.
Step-by-step guide
STEP 1 - Install the CLI
- npm install @brightsec/cli -g || true
STEP 2 - Run (retest) a scan
- If you need to run a new scan with a Crawler, use the following script:
-printf "Start Bright Scan 🏁"
- >
SCAN_ID=$(bright-cli scan:run
--token $BRIGHT_TOKEN
--name "Test Travis Scan"
--project $PROJECT_ID
--crawler www.example.com
--smart)
- printf "Scan was started with ID https://app.brightsec.com/scans/$SCAN_ID\n"
- If you need to re-test a previous scan with its ID
OLD_SCAN_ID
, use the following script:
-printf "Retest a scan"
- >
NEW_SCAN_ID=$(bright-cli scan:retest
--token=$BRIGHT_TOKEN
$OLD_SCAN_ID)
-printf "Scan was started with ID https://app.brightsec.com/scans/$NEW_SCAN_ID\n"
STEP 3 - Poll the results
Note
When polling the scan results, it is recommended to follow the fail-fast principle by using the
breakpoint
command. See Bright CLI Command List for a full list of commands you can use in your Travis flow.
- printf "Wait for issues ⏳\n"
- >
# Poll the scan until it returns something, or its time runs out
bright-cli scan:polling
--interval 30s
--timeout 20m
--token $BRIGHT_TOKEN
--breakpoint medium_issue
$SCAN_ID
allow_failure: true
# After that - stop the scan
- printf "Stop Scan 🛑"
- bright-cli scan:stop --token $BRIGHT_TOKEN $SCAN_ID
STEP 4 - View the results
To view the scan results, go to the Bright app. For the instructions, see here.
Complete example
The following example is made up of the steps above and shows how to run a new scan using the Crawler discovery type:
language: node_js
node_js:
- 10
before_script:
- npm install @brightsec/cli -g || true
script:
- printf "Start Bright Scan 🏁"
- >
SCAN_ID=$(bright-cli scan:run
--token $BRIGHT_TOKEN
--name "Test Travis Scan"
--project $PROJECT_ID
--crawler http://brokencrystals.com
--smart)
- printf "Scan was started with ID https://app.brightsec.com/scans/$SCAN_ID\n"
- printf "Wait for issues ⏳\n"
- >
bright-cli scan:polling
--interval 30s
--timeout 20m
--token $BRIGHT_TOKEN
--breakpoint medium_issue $SCAN_ID
allow_failure: true
after_script:
- printf "Stop Scan 🛑"
- bright-cli scan:stop
--token $BRIGHT_TOKEN $SCAN_ID
Example 2. Scan in the Repeater mode using the Bright CLI (NPM installation)
To apply this option, you need to install the Bright CLI on your Travis CI machine and activate the Repeater using the Repeater ID and Bright API key.
Prerequisites
- You have the Repeater with a valid ID ‘REPEATER’. See Managing Repeaters for the information about handling the Repeaters.
- You have a valid organization API key or personal API key (
BRIGHT_TOKEN
) with the following scopes:bot
,scans : run
,scan : read
, andscans : stop
. - You have created the
BRIGHT_TOKEN
andREPEATER
variables on your Travis CI machine: more options > settings > add the environmental variables. - You have copied the Bright
PROJECT_ID
on the Projects page.
Step-by-step guide
STEP 1 - Install the CLI
- npm install @brightsec/cli -g || true
STEP 2 - Activate the repeater
bright-cli repeater
--token $BRIGHT_TOKEN
--id $REPEATER
--cluster https://app.brightsec.com
Note
If a valid API token
BRIGHT_TOKEN
and Repeater IDREPEATER
were not added, then the Unauthorized access error appears. Please check your credentials.
Important
Make sure that the Repeater has an outbound connection to the Bright host depending on its deployment. The Repeater should be connected either to the default amq.app.brightsec.com via the AMQ protocol (over TLS) using port 5672 or to your private cloud using the relative port.
STEP 3 - Run (retest) a scan
- If you need to run a new scan with a Crawler, use the following script:
-printf "Start Bright Scan 🏁"
- >
SCAN_ID=$(bright-cli scan:run
--token $BRIGHT_TOKEN
--name "Test Travis Scan"
--project $PROJECT_ID
--repeater $REPEATER
--crawler www.example.com
--smart)
- printf "Scan was started with ID https://app.brightsec.com/scans/$SCAN_ID\n"
- If you need to re-test a previous scan with its ID
OLD_SCAN_ID
, use the following script:
-printf "Retest a scan"
- >
NEW_SCAN_ID=$(bright-cli scan:retest
--token=$BRIGHT_TOKEN
$OLD_SCAN_ID)
-printf "Scan was started with ID https://app.brightsec.com/scans/$NEW_SCAN_ID\n"
STEP 4 - Poll the results
Note
When polling the scan results, it is recommended to follow the fail-fast principle by using the
breakpoint
command. See Bright CLI Command List for a full list of commands you can use in your Travis flow.
- printf "Wait for issues ⏳\n"
- >
# Poll the scan until it returns something, or its time runs out
bright-cli scan:polling
--interval 30s
--timeout 20m
--token $BRIGHT_TOKEN
--breakpoint medium_issue $SCAN_ID
allow_failure: true
# After that - stop the scan
- printf "Stop Scan 🛑"
- bright-cli scan:stop
--token $BRIGHT_TOKEN $SCAN_ID
STEP 5 - View the results
To view the scan results, go to the Bright app. For the instructions, see here.
Complete example
The following example is made up of the steps above and shows how to run a new scan using the Crawler discovery type:
language: node_js
node_js:
- 10
before_script:
- npm install @brightsec/cli -g || true
script:
bright-cli repeater
--token $BRIGHT_TOKEN
--id $REPEATER
--bus amqps://amq.app.brightsec.com:5672
- printf "Start Bright Scan 🏁"
- >
SCAN_ID=$(bright-cli scan:run
--token $BRIGHT_TOKEN
--name "Test Travis Scan"
--project $PROJECT_ID
--repeater $REPEATER
--crawler http://brokencrystals.com
--smart)
- printf "Scan was started with ID https://app.brightsec.com/scans/$SCAN_ID\n"
- printf "Wait for issues ⏳\n"
- >
bright-cli scan:polling
--interval 30s
--timeout 20m
--token $BRIGHT_TOKEN
--breakpoint medium_issue $SCAN_ID
allow_failure: true
after_script:
- printf "Stop Scan 🛑"
- bright-cli scan:stop
--token $BRIGHT_TOKEN $SCAN_ID
Example 3. Scan in the Repeater mode using the Bright CLI (Docker installation)
To apply this option, you must configure a Docker image inside your pipeline (for example, by creating a docker-compose file). Once the Docker is configured, you can run the Bright CLI and activate the Repeater using the Repeater ID and Bright API key.
Prerequisites
- You have the Repeater with a valid ID ‘REPEATER’. See Managing Repeaters for the information about handling the Repeaters.
- You have a valid organization API key or personal API key (
BRIGHT_TOKEN
) with the following scopes:bot
,scans : run
,scan : read
, andscans : stop
. - You have created the
BRIGHT_TOKEN
andREPEATER
variables on your Travis CI machine: more options > settings > add the environmental variables. - You have copied the Bright
PROJECT_ID
on the Projects page.
Step-by-step guide
STEP 1 - Create the Docker compose yml
file
yml
fileversion:'3'
services:
brokencrystals.local:
image: neuralegion/brokencrystals
repeater:
image: neuralegion/repeater:latest
restart: always
environment:
REPEATER_TOKEN: ${BRIGHT_TOKEN}
REPEATER_AGENT: ${REPEATER}
DEBUG: bright-cli
STEP 2 - Deploy the Docker and run the CLI
- sudo curl -L "https://github.com/docker/compose/releases/download/1.26.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
- sudo chmod +x /usr/local/bin/docker-compose
- npm install @brightsec/cli -g || true
STEP 3 - Activate the repeater
- - printf "BRIGHT_TOKEN=$BRIGHT_TOKEN\nREPEATER=$REPEATER\n" > .env
- cat .env
- docker-compose --env-file=.env up -d
- docker-compose config
Note
If a valid API token
BRIGHT_TOKEN
and Repeater IDREPEATER
were not added, then the Unauthorized access error appears. Please check your credentials.
Important
Make sure that the Repeater has an outbound connection to the Bright host depending on its deployment. The Repeater should be connected either to the default amq.app.brightsec.com via the AMQ protocol (over TLS) using port 5672 or to your private cloud using the relative port.
STEP 4 - Run (retest) a scan
- If you need to run a new scan with a Crawler, use the following script:
-printf "Start Bright Scan 🏁"
- >
SCAN_ID=$(bright-cli scan:run
--token $BRIGHT_TOKEN
--name "Test Travis Scan"
--project $PROJECT_ID
--repeater $REPEATER
--crawler www.example.local
--smart)
- printf "Scan was started with ID https://app.brightsec.com/scans/$SCAN_ID\n"
- If you need to re-test a previous scan with its ID
OLD_SCAN_ID
, use the following script:
-printf "Retest a scan"
- >
NEW_SCAN_ID=$(bright-cli scan:retest
--token=$BRIGHT_TOKEN
$OLD_SCAN_ID)
-printf "Scan was started with ID https://app.brightsec.com/scans/$NEW_SCAN_ID\n"
STEP 5 - Poll the results
Note
When polling the scan results, it is recommended to follow the fail-fast principle by using the
breakpoint
command. See Bright CLI Command List for a full list of commands you can use in your Travis flow.
- printf "Wait for issues ⏳\n"
- >
# Poll the scan until it returns something, or its time runs out
bright-cli scan:polling
--interval 30s
--timeout 20m
--token $BRIGHT_TOKEN
--breakpoint medium_issue $SCAN_ID
allow_failure: true
# After that - stop the scan
- printf "Stop Scan 🛑"
- bright-cli scan:stop
--token $BRIGHT_TOKEN $SCAN_ID
STEP 6 - View the results
To view the scan results, go to the Bright app. For the instructions, see here.
Complete example
The following example is made up of the steps above and shows how to run a new scan using the Crawler discovery type:
language: node_js
node_js:
- 10
before_script:
- sudo curl -L "https://github.com/docker/compose/releases/download/1.26.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
- sudo chmod +x /usr/local/bin/docker-compose
- npm install @brightsec/cli -g || true
script:
- printf "BRIGHT_TOKEN=$BRIGHT_TOKEN\nREPEATER=$REPEATER\n" > .env
- cat .env
- docker-compose --env-file=.env up -d
- docker-compose config
- printf "Start Bright Scan 🏁"
- >
SCAN_ID=$(bright-cli scan:run
--token $BRIGHT_TOKEN
--repeater $REPEATER
--name "Test Travis Scan"
--project $PROJECT_ID
--crawler http://brokencrystals.local
--smart)
- printf "Scan was started with ID https://app.brightsec.com/scans/$SCAN_ID\n"
- printf "Wait for issues ⏳\n"
- >
(bright-cli scan:polling
--interval 30s
--timeout 20m
--token $BRIGHT_TOKEN
--breakpoint medium_issue $SCAN_ID
allow_failure: true
after_script:
- printf "Stop Scan 🛑"
- bright-cli scan:stop
--token $BRIGHT_TOKEN $SCAN_ID
Updated about 1 year ago