Setting Up the Eclipse Plugin (v9.2.0 and up)
The instructions below refer to local installation of the CxSAST Eclipse Plugin. It is also possible to make the Eclipse plugin centrally available to organizational IDE users, so they can link to it. Upon plugin updates, the organizational IDE users are automatically prompted to update. For further information and instructions, refer to Eclipse Project Update Sites.
Prerequisites
The following components must be installed and available before installing the Checkmarx Eclipse plugin:
The latest version of Eclipse installed
CxSAST 9.4 or higher installed
Connecting to Proxy
In order to set up the CxSAST Eclipse plugin using a proxy, you can now use the built-in proxy settings.
After configuring the proxy, restart the Eclipse environment.
To edit the eclipse.ini file to point to the JDK setup:
Download the CxSAST Eclipse plugin zip archive.
Locate the eclipse.exe file and edit the vm arguments accordingly:
Note
The eclipse version running on Java 8 by default needs to be updated to use Java 11 in the eclipse.ini file.
-vm C:/Program Files/Java/jdk-11.0.13/bin.
To edit the location for generating the Checkmarx plugin logs:
Navigate to and open log4j2.xml with your text editor.
Enter the desired location for the Checkmarx plugin log file, for example to C:\Users\admin\.p2\pool\plugins\com.checkmarx.cxviewer_<version>\config.
The plugin’s log file path can be configured in the log configuration file <eclipse_home_directory>\plugins\com.checkmarx.cxviewer_<version>\config\log4j2.xml. By default, logs will be generated by the name cx_plugin.log under <eclipse_home_directory>\logs directory.
To set up and configure the CxSAST Eclipse plugin:
Notice
For instructions on local installation of the CxSAST Eclipse Plugin on Linux, refer to Setting Up the CxSAST Eclipse Plugin on Linux.
Download the CxSAST Eclipse plugin zip archive.
Open Eclipse, go to the Help menu and select Install New Software.
Click <Add...>.
Enter a name into the Name field, for example, CxViewerPlugin.
Notice
To make the plugin centrally available to all organizational Eclipse users and enable automatic prompts for plugin updates:
Place the downloaded plugin zip archive on the CxSAST Server (in a distributed deployment: on CxManager).
On that Server, create a folder named Eclipse in the web server's home directory, for example: C:\inetpub\wwwroot\Eclipse.
Extract the plugin archive to the Eclipse folder.
In Eclipse, go to Location and type: http://<CxSAST>/Eclipse/, where <CxSAST> is the IP address or resolvable hostname of the CxSAST server.
Click <Archive...>, browse to the CxEclipsePlugin zip file and click <Open>.
Select the CxViewer plugin and complete the wizard.
Restart the Eclipse environment.
In Eclipse, go to the Window menu and select Preferences.
From CxViewer Preferences, select Authentication.
Type the path to the CxSAST server in the Server URL field (e.g., http://<server_name>). It is recommended that you use the hostname.
Notice
Make sure that no "/" is added at the end of http://<server_name>, which could happen when copying and pasting the URL/hostname in.
In case of server connection issues, enter the hostname instead of the IP address in the server URL field. Both the IP address and the hostname are listed in the etc/hosts file (for example, 10.32.5.117 sdlc-sast-89.cxquality.com).
Click <Test> to validate the connection.
Notice
The Logout button can be used in case you want to log in using a different user or to a different server.
The ‘Trust All SSL Certificates’ checkbox can be used to add certified security to the connection in the following:
When enabled, all certificates are trusted.
When disabled (by default), only certificates signed by a trusted certificate authority can be accepted.
Notice
The checkbox is only enabled when the URL starts with ‘https’ (SSL).
Click Apply and Close.
Notice
If you want to improve your viewing experience, it is recommended to avoid using a laptop or small screen.
To remove the plugin:
Unbind all projects and then use the Windows uninstallation option to uninstall the Checkmarx plugin