Skip to main content

Using the Checkmarx One Eclipse Plugin

Once you have run a Checkmarx One scan on the source code of your Eclipse project, you can import the scan results into your Eclipse IDE. The results are integrated within the IDE in a manner that makes it easy to identify the vulnerable code, triage the results, and take the required remediation actions.

First you need to import the results from the latest scan of your Eclipse project. Then you can view the results in your Eclipse IDE.

Notice

Alternatively, you can run a new can on an existing Checkmarx One project from your IDE and load the results.

Loading your Checkmarx One Results

Figure 1. 
Eclipse_Plugin_-_Loading_scan_results.gif

GIF - How to load and view Checkmarx scan results in Eclipse



To load results from a scan:

  1. In your Eclipse project, click on Window > Show View > Other.

    Viewing_Eclipse_1.png

    The Show View window opens.

  2. Select Checkmarx > Checkmarx One Scan from the list to open the Checkmarx View (or search for Checkmarx One Scan in the search box) and click Open.

    Viewing_Eclipse_2.png

    The Checkmarx panel opens at the bottom of the screen.

    Viewing_Eclipse_3.png

    Notice

    If you haven’t done the initial setup, the Open Settings button is shown in the Checkmarx panel. Click on the button and then configure the integration as described in Installing and Setting up the Checkmarx One Eclipse Plugin.

  3. Enter the Scan ID of the scan for which you want to show results (i.e., the most recent scan of your Eclipse project). Use one of the following methods to enter the Scan ID:

    Warning

    Only scans that completed successfully are shown in the IDE. Scans with only partial results aren't shown.

Running Scans from Eclipse

You can run a new Checkmarx One scan on the project that is open in your Eclipse workspace.

You must first create a Checkmarx project and run the initial scan using some other method, e.g., web portal, API, CLI etc. and load the scan results in the Eclipse console. Then, you are able to run subsequent scans on that project from Eclipse. The scan applies the scan configuration that was used for the previous scan of this project. For example, if the last time you scanned this project you excluded certain files, those files will be excluded also from the current scan.

Notice

Scans initiated via the IDE are "Incremental" scans. Learn more about incremental scans here.

Warning

This feature needs to be enabled for your organization's account by a Checkmarx admin user under Settings.pngSettings > Global Settings > Plugins in the Checkmarx One web portal. Before enabling this feature, you should consider the ramifications; since there is a limitation to the number of concurrent scans that you can run based on your license, enabling IDE scans may cause scans triggered by CI/CD pipelines and SCM integrations to be added to the scan queue (run on a "first in first out" basis), causing major delays for those scans.

Figure 2. Running Scans from the IDE
Running Scans from the IDE

GIF - How to run a new scan from the IDE



To run a scan:

  1. In the Checkmarx panel in your IDE, open the existing Checkmarx project under which your current workspace has already been scanned.

  2. In the header bar of the Checkmarx panel, click on the "play" button.

    Viewing_Eclipse_9.png

    Notice

    Checkmarx runs a sanity check to verify that your current workspace matches the files that were previously scanned under this Checkmarx project. If a mismatch is detected, a warning is shown. You are given the option to run the scan despite the mismatch.

  3. When the scan is completed, a dialog appears, asking if you would like to load the results from the new scan. Click Yes to show the new scan results in the Checkmarx panel.

Viewing Checkmarx One Scan Results in the Checkmarx View

You can open the Checkmarx panel below your project and navigate the tree display to view details about a specific vulnerability.

Notice

In order to show the source code for a specified attack vector, you need to have the relevant project open in your Eclipse console.

To view the Checkmarx One results in the Checkmarx panel:

  1. After you import the scan results, and the results are shown in the Checkmarx panel, click on an arrow to expand that node in the tree.

  2. You can use the Checkmarx Toolbar (on the right) to adjust the display, see actions below.

  3. Click on a vulnerability.

    The details panel is shown on the right, including a summary of the vulnerability info, a brief description and the Attack Vector (for SAST vulnerabilities).

    Viewing_Eclipse_8.png

  4. Click on a node in the Attack Vector.

    An editor opens containing the source code in the respective file and location for the selected node.

    6296043559.png

Checkmarx Toolbar

Icon

Item

Description

6293651457.png

Filter High

Show/hide high severity vulnerabilities.

6293618689.png

Filter Medium

Show/hide medium severity vulnerabilities.

6291915195.png

Filter Low

Show/hide low severity vulnerabilities.

6293716993.png

Filter Info

Show/hide info severity vulnerabilities.

6292930588.png

Run scan

Runs a new scan on the project that is open in your workspace

6290244338.png

Cancel scan

Cancels the scan that is running.

6291554781.png

Filter by state

Filter results by state (multi-select, by default all are selected except for Not Exploitable and Proposed Not Exploitable)

6291554789.png

More options

  • Group by - Select/deselect grouping categories. Options are: Severity, Query Name and State. You can group by multiple parameters. The groups will be nested according to the order in which they are selected (i.e., the first selection will be the top level grouping and the next selection will be the nested grouping below that etc.)

  • Clear result selection - Clear the Project, branch and scan selection and refresh the Project selection list.

  • Preferences - Configure the Checkmarx One plugin preferences (settings).

Managing (Triaging) Results

Checkmarx One tracks specific vulnerability instances throughout your SDLC. Each vulnerability instance has a ‘Predicate’ associated with it, which is comprised of the following attributes: ‘state’, ‘severity’ and ‘comments’. After reviewing the results of a scan, you have the ability to triage the results and modify these predicates accordingly. For more info about triaging results in Checkmarx One, see Managing (Triaging) Vulnerabilities.

You can manage the results directly in the Eclipse console.

Warning

Only users with the Checkmarx One role update-result (e.g., a risk-manager) are authorized to make changes to the predicate. Only users with the role update-result-not-exploitable (e.g., an admin) are authorized to mark a vulnerability as ‘Not Exploitable’.

To edit the result predicate:

  1. Navigate to the vulnerability that you would like to edit.

  2. To adjust the severity, click on the Severity field, and select from the dropdown list the severity that you would like to assign. Options are: High, Medium, Low or Info.

    6295486491.png

  3. To adjust the state, click on the State field, and select from the dropdown list the state that you would like to assign. For SAST and KICS, options are: To Verify, Not Exploitable, Proposed Not Exploitable, Confirmed or Urgent. For SCA, options are: Not Ignored or Ignored.

    Notice

    If you mark a vulnerability as Not Exploitable or Ignored it will not be shown in the results in the web app for this scan or for subsequent scans of this Project.

  4. To add a comment, click on the Enter comment field and enter your comment.

  5. In order to apply your changes, click Update.

    The new predicate is applied to the vulnerability instance in this scan as well as to recurring instances of the vulnerability in subsequent scans of the Project. The changes made to the predicate are shown in the Changes tab.

In this section: