Skip to main content

Scanning a Project

Preparing your Source Code for Scanning

If the source code uses a “lock” file, you must also include the package.json file in the project folder.

Running a Scan Manually

You can manually run a scan of an existing Project through the web application, using one of the following methods:

Notice

If you haven’t yet set up a Project for the source code that you would like to scan, then first create the Project as described in Creating a Project - Project Types.

  • On the Project page, hover over the Scan icon located on the top right corner of the page and click the Scan Project button.

    6414532688.png

Notice

If the Project has not yet been scanned, then the Scan now button is shown in the center of the screen. Otherwise, the procedure is identical whether this is the initial scan or a rescan of a Project that has already been scanned.

  • On the Dashboard (Home page), in the Projects pane, click onMore_Options.png in the row of the desired Project and select Scan Project.

    6412042728.png
  • For a General project, the Scan project dialog opens. Enter the zip file or Git URL, since Checkmarx SCA does not save this information.

    6414237836.png
  • For a GitHub project, the scan starts immediately, since Checkmarx SCA saves the access token and Git URL.

Warning

If the access token has been deleted from GitHub, you will get an error message when you try to re-scan the project.

Scan Automation

You can set up integrations that will automatically trigger scans as part of your SDLC, e.g., scanning the project before each build. This can done using the Checkmarx CLI plugin or specialized plugins for various platforms (e.g., Jenkins, Azure DevOps etc.), see Checkmarx SCA - Integrations and Plugins.

If you are using Checkmarx SCA Agent and a GitHub repo, the integration can be done using webhooks, see CxFlow Configuration (GitHub Webhooks) .