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 will be automatically prompted to update. For details, see Eclipse Project Update Sites.
The user performing the installation must have administrative permissions.
The CxSAST Eclipse plugin within the plugins repository is only compatible with the latest CxSAST version. Please download plugins for older CxSAST versions from https://www.checkmarx.com/plugins/.
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 set up and configure the CxSAST Eclipse plugin:
Download the CxSAST Eclipse plugin zip archive.
In Eclipse, go to the Help menu and select Install New Software.
Add a name in the Name field (for example, CxViewerPlugin).
To make the plugin centrally available to all organizational Eclipse users, and also 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 field (e.g. http://<server_name>). It is recommended that you use the hostname.
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).
Select the "SAML" option if the SAML single sign-on feature is enabled.
The SAML Single Sign-In option won’t be available unless SAML is enabled in CxSAST (see SAML Management).
Add your CxSAST user credentials or select the "Use Current User" option if the SSO feature is active.
For domain user include the domain in front of the username (e.g. <domain>\<username>)
If you subsequently need to remove the plugin, unbind all projects and then use Windows' programs removal feature to uninstall the Checkmarx plugin.