framework-contrast-security-agent.md

Contrast Security Agent Framework

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

Detection Criterion	Existence of a single Contrast Security service is defined as the VCAP_SERVICES payload containing at least one of the following: name that has the substring contrast-security. Note: This is only applicable to user-provided services label that has the substring contrast-security. tags that have the substring contrast-security. credential payload containing the key contrast_referral_tile
Tags	contrast-security

Tags are printed to standard output by the Buildpack detect script.

User-Provided Service (Optional)

Users may optionally provide their own Contrast Security service. A user-provided Contrast Security service must have a name or tag with contrast-security in it so that the Contrast Security Agent Framework will automatically configure the application to work with the service.

The credential payload of the service must contain the following entries:

Name	Description
username	A user with application onboarding permission
api_key	The user's api key
service_key	The user's service key
teamserver_url	The url to your Teamserver instance

Configuration

The framework can be configured by modifying the config/contrastsecurityagent.yml file in the buildpack fork.

Name	Description
repository_root	The URL of the Contrast Security repository index.