Skip to main content

Getting Started with the Checkmarx SCA Agent

Warning

We have discontinued development of this tool, and do not plan on releasing new versions. Checkmarx technical support no longer provides support for its use.

Installation

Prerequisites

This section describes the software and hardware prerequisites for installing the Checkmarx SCA Agent on premise.

Hardware and Software Requirements

  • x86_64 CPU architecture

  • At least quad core 2 GHz CPU

  • At least 16 GB of RAM

  • At least 120 GB of free disk space

  • Linux or Windows

    • On Windows, it is recommended to use WSL2 as your Docker backend. This way the Docker containers are running natively on Linux.

  • A user with sudo privileges

  • Docker and Docker Compose installed (Recommended Docker version 19.03 and later)

Downloading the SCA Agent Package

Download the latest SCA Agent release to the SCA Agent target machine from https://github.com/cxsca/sca-agent/releases/latest/download/sca-agent.zip

Setup

This section describes how to install, configure, and run the SCA Agent.

Notice

  • You install, configure, and run the SCA Agent on the SCA Agent target machine, in the SCA Agent folder.

  • The agent comes with a default set of configurations that can be changed as described in the following procedure.

  1. Install the latest versions of Docker and Docker Compose.

  2. Execute the setup script using one of the following commands:

    • For Linux or WSL2 use:

      $ ./setup.sh

    • For Windows without WSL2 use:

      docker run --rm -it -v //var/run/docker.sock:/var/run/docker.sock -v %cd%:/sca-agent -w /sca-agent docker/compose ./setup.sh

  3. Configure the .env file according to your needs.

    • The EXTERNAL_HOSTNAME variable must match the DNS or the IP of the machine where the agent is installed.

    • For EU environments, the URLs in the .env configuration file must be prefixed with "eu.".

    • To configure plugins to work with the agent, both the SCA API URL and the AC URL need to point to the agent.

    • If the agent is installed behind a proxy, edit the .env file to include a line similar to the following:

      HTTPS_PROXY=http://172.31.29.145:3128

  4. Start the agent, using the following command:

    $ sudo docker-compose up -d

Upgrading

To upgrade the SCA Agent:

  1. Stop the agent, using the following command:

    $ sudo docker-compose down

  2. Download the latest SCA Agent release from https://github.com/cxsca/sca-agent/releases/latest/download/sca-agent.zip.

  3. Unzip the sca-agent.zip file.

  4. Run:

    $ sudo chmod +x setup.sh && ./setup.sh

  5. Start the agent, using the following command:

    $ sudo docker-compose up -d