Skip to main content

Installing and Setting up the Checkmarx One JetBrains Plugin

Installing the Plugin

The Checkmarx One JetBrains Plugin is available on the JetBrains marketplace, and can be installed directly from your JetBrains IDE console.

To install the plugin from the marketplace:

  1. Open your JetBrains IDE console (e.g., IntelliJ IDEA).

  2. Go to Settings > Plugins and click on the Marketplace tab.

  3. Search for the Checkmarx AST plugin, then click Install for that plugin.

    Image_320.png

  4. Follow the prompts to run the installation.

    The plugin is installed.

Automatic Updates - Release Versions and Pre-Release Versions

Once you have installed the Checkmarx plugin, it is automatically updated to the latest version whenever we create a new release.

Whenever new code is merged in between full releases, we create nightly pre-release versions. You can choose to install a pre-release version. Once you have installed a pre-release version, you will continue to get automatic updates whenever a new pre-release (or release) is created.

Warning

Pre-release versions haven't been tested and approved for distribution. Therefore, there is some degree of risk involved in using pre-release versions.

To start getting pre-release versions:

  1. Go to File > Settings > Plugins and click on the Settings.png icon in the header bar.

  2. Select Manage Plugin Repositories.

    Image_110.png

  3. In the Custom Plugin Repositories dialog click "+" and enter https://plugins.jetbrains.com/plugins/nightly/17672/, then click OK.

  4. Search for the Checkmarx plugin.

    The latest pre-release version is shown.

  5. Click Update and then click OK.

    Notice

    You can revert at any time to only getting release versions by opening the Custom Plugin Repositories dialog and deleting the nightly channel.

Setting up the Plugin

After installing the plugin, in order to use the Checkmarx One tool you need to configure access to your Checkmarx One account, as described below.

Note

If you would like to use a proxy server, you can set up a proxy variable in one of two ways. See below.

  1. In the JetBrains console, navigate to Settings > Tools > Checkmarx One.

    The Checkmarx One Settings window is shown.

    Image_1248.png

  2. In the Credentials section, connect to Checkmarx One either using an API Key or your login credentials.

    • Login Credentials

      1. Select the OAuth checkbox.

      2. Enter the Base URL of your Checkmarx One environment and the name of your tenant account, then click Connect to Checkmarx.

        Notice

        Once you have submitted a base URL and tenant name, it is saved in cache and can be selected for future use (saves up to 10 accounts).

      3. If you are logged in to your account, the system connects automatically. If you are not logged in, your account's login page opens in your browser. Enter your Username and Password and then your One-Time Password (2FA) to log in.

    • API Key

      1. Select the API key checkbox.

      2. In the API key textbox, enter your Checkmarx One API Key.

        Notice

        To create an API key, see Generating an API Key

        The roles (permissions) assigned to the API Key are inherited from the user account that generates the key. Therefore, make sure that you are logged in to an account with the appropriate roles.

        The following are the minimum required roles for accessing the full functionality of the IDE plugins:

        • CxOne composite role ast-scanner

        • IAM role default-roles

  3. A Checkmarx welcome page is displayed immediately after a successful login. This page provides a selection box to enable CxOne Assist realtime scanners. If you would like to enable this feature, mark the selection box. Either way, close the window and proceed to the next step.

  4. Go back to the Settings tab, and in the Additional Parameters field, you can submit additional CLI params. This can be used to manually submit the base url and tenant name if there is a problem extracting them from the API Key. It can also be used to add global params such as --debug or --proxy. To learn more about CLI global params, see Global Flags.

  5. Click on Connect to Checkmarx, to test that the connection works.

    Notice

    If the connection fails, you can view detailed error logs by entering --debug in the Additional parameters section and retrying the connection.

  6. Click OK at the bottom of the screen.

Configuring CxOne Developer Assist

  1. Navigate to JetBrains settings, drill down to tools > Checkmarx One > CxOne Assist. Alternatively: If a project is open, click on the Checkmarx icon in the left-hand navigation bar and click on the settings icon. In the window that opens, click on Go to CxOne Assist toward the bottom of the window.

    The CxOne Assist settings window is displayed.

  2. To activate the Open Source Realtime Scanner (OSS-Realtime), mark the check box underneath that option.

    Note

    If you selected the checkbox in the Checkmarx Welcome page, this option will already be marked as activated.

  3. Click on Install MCP.

    The Checkmarx MCP is added to your mcp.json file.

    Notice

    In some cases the MCP is installed automatically when you authenticate with Checkmarx. However, best practice is to click on Install MCP so that the MCP file opens and you can ensure that it starts running, as shown in the following step.

  4. If the process doesn't start automatically, you may need to open the file and click Start.

    Image_143.png

    Notice

    If there is a problem with the automatic installation, check Troubleshooting - Manually Configuring the MCP Server.

  5. Click OK at the bottom of the window.

Setting up a Proxy Variable (Optional)

There are two ways to set up a proxy variable in JetBrains: using additional parameters in JetBrains or using your system’s environment variables.

Setting up a Proxy Variable using your OS System Environment Variables

  • In your operating system (e.g., Windows, iOS, Linux, etc.), set up a system environment variable with the following configuration:

    • In the Name field, enter HTTP_PROXY.

    • In the Value field, enter the value of your proxy address using the following format:http://<proxy_ip>:<port_number> If authentication is required, then the format should be: http://<username>:<password>@<proxy_ip>:<port_number>.

      Notice

      Make sure to include the http:// prefix.

      It is not recommended to pass the username and password in clear text.

Setting up a Proxy using Additional Parameters

  1. In the main navigation, click Customize > All settings.

    The Settings window is shown.

  2. In the Settings window, click Tools > Checkmarx One (or search for Checkmarx One in the search box).

    The Checkmarx One JetBrains plugin configuration settings are shown.

  3. In the Additional parameters section, configure your proxy using the following format http://<proxy_ip>:<port_number>. If authentication is required, then the format should be http://<username>:<password>@<proxy_ip>:<port_number>.

    Notice

    Make sure to include the http:// prefix.

    It is not recommended to pass the username and password in clear text.

  4. Click OK at the bottom of the screen.

In this section: