Contrast CVE Shield: How to Install an Agent Directly

Overview

Learn how to install and configure an agent with Contrast Security's Flex Agent. The Flex Agent lets CVE Shield scan your Java applications. This one time setup should take less than 15 minutes to complete.

Before you begin

• You need an active CVE Shield account. Sign in to the Northstar web interface before you start. Don't have a CVE Shield account? Register here: Contrast Security

• You need permission to run sudo commands with admin access to the computer or server where you will install the agent.

• You need a Java application.

Note: CVE Shield only supports Java applications currently. Check that your application uses Java before you continue. Support for other languages is coming in a future CVE Shield release.

Steps

1. Select an installation method

In Northstar, go to Administration > Agent management, and select + Add Agent in the top right corner of the page.

2. In the Agent Wizard, select Flex Agent directly.

(Insert screenshot: Select an installation method – Flex Agent directly)

3. Install Contrast's Flex Agent

Run the command displayed in the wizard on your server. The <your_agent_token> is automatically replaced with your organization's Agent key.

4. (Optional) Validate the install file

This next part is optional, but we recommend it because it checks that the install file is safe before you run it.

Select Show more, and run the command displayed in the wizard.

This installation step runs silently. If everything is set up correctly, the installer will start automatically and you'll see its output next. If nothing happens after a few seconds, the checksum didn't match. Check your internet connection and try again.

5. Generate some traffic

Open your Java application. Click a few links or send a few requests. This gives the agent something to detect.

6. Check in Northstar

Select View agent activity to go to Explorer > CVEs. If your application appears, the agent is working.

(Insert screenshot: Interact with your application and check in the Northstar web interface)

Expected Outcome

Your application appears in Northstar on the Agent management screen soon after you start using it. When your application appears, CVE Shield starts finding vulnerabilities in that application.

Related Resources

• How to install an Agent with a Kubernetes Helm Chart (if you run applications in a cluster)

• Troubleshooting your first scan (if an agent doesn't report data)

Escalation Path

• Free Entry: Post your question in the Gather Community Forum. Include any error messages you saw.