Skip to main content

Setting Up the IntelliJ Plugin

The instructions below refer to the local installation of the IntelliJ Plugin. It is also possible to make the IntelliJ 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, search "IntelliJ idea Enterprise Plugin Repositories".

Notice

The IntelliJ plugin within the repository is only compatible with the latest CxSAST version. Therefore, a prior version of the CxSAST IntelliJ plugin must be updated to work with CxSAST v9.0.0 (and up).

To install and configure the IntelliJ Plugin:

  1. Download the IntelliJ Plugin zip archive.

  2. In IntelliJ, go to File and click Settings.

    Int_1.png

  3. Select Plugins and click Install plugin from disk.

    Int_2.png

  4. Navigate to the downloaded IntelliJ plugin ZIP file archive and click OK.

    Int_3.png

  5. Click OK and restart IntelliJ.

  6. In IntelliJ, go to File and then click Settings.

  7. From Other Settings, select CxViewer Preferences. The Authentication window is displayed.

    Int_4.png

  8. Enter the path to the CxSAST server in the Server URL field (for example, http://<server_name>.

  9. Click <Test Connection> to validate the connection.

  10. Click <Apply> and then <OK>.

Notice

  • The Logout button can be used if you want to log on to a different server or as a different user.

  • The ‘Accept non trusted certificates’ checkbox can be used to add certified security to the connection in the following:

    • When enabled (by default), all non-trusted certificates are accepted, for example, a self-signed server.

    • When disabled, only certificates signed by a trusted certificate authority can be accepted.

  • The checkbox is only enabled if the URL starts with https (self-signed).

  • In case of server connection issues, enter the hostname instead of the IP address in the server URL field. The IP address and the hostname are listed in the etc/hosts file, for example, 10.32.5.117 sdlc-sast-89.cxquality.com.

  • The OpenId Connect-based authentication requires registered OAuth 2.0 clients with supported redirect URLs.  DNS hostname or IP Address can be used if URLs redirect URLs exist. If not present, an 'invalid redirect URL' error could be seen during the authentication. While using the DNS hostname, ensure it resolves to the Checkmarx server's IP address.  If the scan results are not displayed while using the IP address, specify the Checkmarx Server URL with the DNS hostname.

In this section: