Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 35 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img src="https://raw.githubusercontent.com/Checkmarx/ci-cd-integrations/main/.images/banner.png">
<img src="https://raw.githubusercontent.com/Checkmarx/ci-cd-integrations/main/.images/PluginBanner.jpg">
<br />
<div align="center">

Expand All @@ -15,7 +15,7 @@
<br />
<p align="center">
<a href="https://github.com/Checkmarx/ast-eclipse-plugin">
<img src="https://raw.githubusercontent.com/Checkmarx/ci-cd-integrations/main/.images/logo.png" alt="Logo" width="80" height="80" />
<img src="https://raw.githubusercontent.com/Checkmarx/ci-cd-integrations/main/.images/cx_azure_x-icon-80px.png" alt="Logo" width="80" height="80" />
</a>

<h3 align="center">CHECKMARX ONE ECLIPSE PLUGIN</h3>
Expand All @@ -35,7 +35,7 @@
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<a href="#overview">Overview</a>
</li>
<li>
<a href="#getting-started">Getting Started</a>
Expand All @@ -53,18 +53,20 @@



<!-- ABOUT THE PROJECT -->
## About The Project
<!-- Overview -->
## Overview

The Checkmarx One Eclipse plugin enables you to import results from a Checkmarx One scan directly into your IDE. You can view the vulnerabilities that were identified in your source code and navigate directly to the vulnerable code in the editor.
Checkmarx continues to spearhead the shift-left approach to AppSec by bringing our powerful AppSec tools into your IDE. This empowers developers to identify vulnerabilities and remediate them **as they code**. The Checkmarx Eclipse plugin integrates seamlessly into your IDE, enabling you to access the full functionality of your Checkmarx One account (SAST, SCA, IaC Security) directly from your IDE.

### Main Features
Import Checkmarx One scan results into your IDE
You can run new scans, or import results from scans run in your Checkmarx One account. Checkmarx provides detailed info about each vulnerability, including remediation recommendations and examples of effective remediation. The plugin enables you to navigate from a vulnerability to the relevant source code, so that you can easily zero-in on the problematic code and start working on remediation.

* Show results from all scan types (CxSAST, CxSCA, and KICS)
* Group results by severity or query name
* Navigate from results directly to the vulnerable code in the editor
* Vulnerable code is highlighted in the editor
### Main Features
* Access the full power of Checkmarx One (SAST, SCA, and IaC Security) directly from your IDE
* Run a new scan from your IDE even before committing the code, or import scan results from your Checkmarx One account
* Provides actionable results including remediation recommendations. Navigate from results panel directly to the highlighted vulnerable code in the editor and get right down to work on the remediation.
* Group and filter results
* Triage results (by adjusting the severity and state and adding comments) directly from the Visual Studio console
* Links to Codebashing lessons


<!-- GETTING STARTED -->
Expand All @@ -73,16 +75,35 @@ Import Checkmarx One scan results into your IDE

### Prerequisites

- You have a Checkmarx One account and you have an [API Key](https://checkmarx.com/resource/documents/en/34965-68618-generating-an-api-key.html).
- An eclipse installation, version 2019-03 (4.11) or above.
> Supported platforms: Windows, Mac, Linux/GTK

- You have an **API key** for your Checkmarx One account. To create an
API key, see [Generating an API Key](https://checkmarx.com/resource/documents/en/34965-68618-generating-an-api-key.html)
> In order to use this integration for running an end-to-end flow of
scanning a project and viewing results, the API Key must have at a
minimum the out-of-the-box composite role `ast-scanner` as well as
the IAM role `default-roles`.
### Setting Up

All the procedures to set the Eclipse plugin up can be found [here](https://checkmarx.com/resource/documents/en/34965-68728-checkmarx-one-eclipse-plugin.html).
1. Verify that all prerequisites are in place.

2. Install the **Checkmarx One** plugin and configure the settings as described [here](https://checkmarx.com/resource/documents/en/34965-68729-installing-and-setting-up-the-checkmarx-one-eclipse-plugin.html).

## Usage

To see how you can use our tool, please refer to the [Documentation](https://checkmarx.com/resource/documents/en/34965-68728-checkmarx-one-eclipse-plugin.html)

## How To Videos
- **Installing and Setting up the Plugin**
![GIF - How to install and set up the plugin](https://checkmarx.com/resource/documents/en/image/164fe2f621388d.gif "GIF - How to install and set up the plugin")

- **Running a Scan from the IDE**
![Running a Scan from the IDE](https://checkmarx.com/resource/documents/en/image/164fe2f62587ef.gif "Running a Scan from the IDE")

- **Loading and Viewing Scan Results**
[![Loading and Viewing Scan Results](https://checkmarx.com/resource/documents/en/image/164fe2f6237dfa.gif "Loading and Viewing Scan Results")](https://checkmarx.com/resource/documents/en/image/164fe2f6237dfa.gif "Loading and Viewing Scan Results")

## Contribution

We appreciate feedback and contribution to the ECLIPSE PLUGIN! Before you get started, please see the following:
Expand Down
2 changes: 1 addition & 1 deletion checkmarx-ast-eclipse-plugin/.classpath
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@
<classpathentry kind="lib" path="lib/commons-lang3-3.18.0.jar"/>
<classpathentry kind="src" path="src"/>
<classpathentry kind="output" path="target/classes"/>
</classpath>
</classpath>
28 changes: 14 additions & 14 deletions logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.