You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Updated README.md file with new images
* renamed the images in README.md
* Updated the content in README.md
* Added How to videos section in README.md
* Updated old logo with new one in code
* changed x icon in README.md
* Updated new X logo in README.md
* Replaced old logo.svg file with new one
* Upgraded Jackson libraries to 2.15.2 with updated dependencies and JARs
* removed old version jar
* used new logo cx_azure_x-icon-80px.png README.md
<h3align="center">CHECKMARX ONE ECLIPSE PLUGIN</h3>
@@ -35,7 +35,7 @@
35
35
<summary>Table of Contents</summary>
36
36
<ol>
37
37
<li>
38
-
<a href="#about-the-project">About The Project</a>
38
+
<a href="#overview">Overview</a>
39
39
</li>
40
40
<li>
41
41
<a href="#getting-started">Getting Started</a>
@@ -53,18 +53,20 @@
53
53
54
54
55
55
56
-
<!--ABOUT THE PROJECT-->
57
-
## About The Project
56
+
<!--Overview-->
57
+
## Overview
58
58
59
-
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.
59
+
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.
60
60
61
-
### Main Features
62
-
Import Checkmarx One scan results into your IDE
61
+
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.
63
62
64
-
* Show results from all scan types (CxSAST, CxSCA, and KICS)
65
-
* Group results by severity or query name
66
-
* Navigate from results directly to the vulnerable code in the editor
67
-
* Vulnerable code is highlighted in the editor
63
+
### Main Features
64
+
* Access the full power of Checkmarx One (SAST, SCA, and IaC Security) directly from your IDE
65
+
* Run a new scan from your IDE even before committing the code, or import scan results from your Checkmarx One account
66
+
* 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.
67
+
* Group and filter results
68
+
* Triage results (by adjusting the severity and state and adding comments) directly from the Visual Studio console
69
+
* Links to Codebashing lessons
68
70
69
71
70
72
<!-- GETTING STARTED -->
@@ -73,16 +75,35 @@ Import Checkmarx One scan results into your IDE
73
75
74
76
### Prerequisites
75
77
76
-
- 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).
78
+
- An eclipse installation, version 2019-03 (4.11) or above.
79
+
> Supported platforms: Windows, Mac, Linux/GTK
77
80
81
+
- You have an **API key** for your Checkmarx One account. To create an
82
+
API key, see [Generating an API Key](https://checkmarx.com/resource/documents/en/34965-68618-generating-an-api-key.html)
83
+
> In order to use this integration for running an end-to-end flow of
84
+
scanning a project and viewing results, the API Key must have at a
85
+
minimum the out-of-the-box composite role `ast-scanner` as well as
86
+
the IAM role `default-roles`.
78
87
### Setting Up
79
88
80
-
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).
89
+
1. Verify that all prerequisites are in place.
90
+
91
+
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).
81
92
82
93
## Usage
83
94
84
95
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)
85
96
97
+
## How To Videos
98
+
-**Installing and Setting up the Plugin**
99
+

100
+
101
+
-**Running a Scan from the IDE**
102
+

103
+
104
+
-**Loading and Viewing Scan Results**
105
+
[](https://checkmarx.com/resource/documents/en/image/164fe2f6237dfa.gif"Loading and Viewing Scan Results")
106
+
86
107
## Contribution
87
108
88
109
We appreciate feedback and contribution to the ECLIPSE PLUGIN! Before you get started, please see the following:
0 commit comments