Skip to main content

Checkmarx One JetBrains Plugin Initial Setup

After installing the plugin, you need to configure access to the Checkmarx One server before you can start importing results in your JetBrains IDE.

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

Setting up the Plugin

To set up the plugin:

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

    6063816768.png

    The Settings window is shown.

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

    6061457704.png

    The Checkmarx One JetBrains plugin configuration settings are shown.

  3. Fill in the Checkmarx server URL with the appropriate URL for your environment.

  4. If the authentication URL is different from the server URL, then select the Use authentication URL checkbox and enter the appropriate authentication URL.

    Notice

    For Checkmarx One cloud platform, enter the URL for your environment.

  5. For Tenant name, enter the name of your Checkmarx One tenant account.

  6. In the API key field, enter your Checkmarx One API key.

    Notice

    If you need to create an API key, see Generating an API Key.

  7. In the Additional parameters section you can specify any CLI arguments that you would like to apply as global flags (e.g., proxy servers). See documentation here.

  8. Click on Validate connection, 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.

  9. Click OK at the bottom of the screen.

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 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 variable using the following format --proxy http://username:[email protected]:8080/.

    Notice

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

  4. Click OK at the bottom of the screen.

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://username:[email protected]:8080/.