Contrast Security Agent Framework

September 17, 2019 ยท View on GitHub

The Contrast Security Agent Framework causes an application to be automatically configured to work with a bound Contrast Security Service.

Detection CriterionExistence of a single bound Contrast Security service. The existence of an Contrast Security service defined by the VCAP_SERVICES payload containing a service name, label or tag with contrast-security as a substring.
Tags are printed to standard output by the buildpack detect script

User-Provided Service

When binding ContrastSecurity using a user-provided service, it must have name or tag with contrast-security in it. The credential payload can contain the following entries:

NameDescription
api_keyYour user's api key
service_keyYour user's service key
teamserver_urlThe base URL in which your user has access to and the URL to which the Agent will report. ex: https://app.contrastsecurity.com
usernameThe account name to use when downloading the agent

Configuration

For general information on configuring the buildpack, including how to specify configuration values through environment variables, refer to Configuration and Extension.

The framework can be configured by modifying the config/contrast_security_agent.yml file in the buildpack fork. The framework uses the Repository utility support and so it supports the version syntax defined there.

NameDescription
repository_rootThe URL of the Contrast Security repository index (details).
versionThe version of Contrast Security to use. Candidate versions can be found in this listing.