Build Integrations

Build integrations enable the automated scanning of your projects for continuous security and compliance across all your projects and products.

Currently Supported Integrations

  • Azure DevOps

  • Jenkins Pipeline

  • Bitbucket Pipeline

  • Circle CI

  • GitHub Actions

  • Gitlab Pipeline

Build Integration Steps

Threatrix Threat Agent runs scans from within your build environment, allowing for automated and continuous open source security and license compliance data to be sent to your team.

As a build step, scans run during a build and are typically kicked off during a pull request. Integrated scans enable your development to spot security problems, in your open source, before merging their changes into your main branch. Scan summary reports can be generated to annotate your pull request making it fast and easy for developers to find and fix vulnerabilities and license violations.

Just a few simple steps are required to get you up and running.

  1. Collect the information required to configure your build environment.

  2. Configure your build server with the environment variables.

  3. Add a build step to download Threat Agent and execute a scan.

Environment Variables

Whlle these values can be passed directly to the agent on the command line, it's often more security and helpful to implement them as environment variables within your build server.

  • THREATRIX_OID [REQUIRED]: The organization ID - Found in admin and user profile.

  • THREATRIX_EID [REQUIRED]: The entity ID for which scan results will be associated. This must be an entity for the user associated with the API_TOKEN to have rights.

  • THREATRIX_API_KEY [REQUIRED] - The access key used for the scan. Found in the admin or user profile

Threat Agent Scan Options

Our Threat Agent requires minimal configuration as it can detect it's environment and self configure based on that context. However, several command line options and scan are available.

Build Server Configuration

Please see the respective build server documentation.

Last updated