JetBrains

Integrate the Cortex AppSec code security plugin with your JetBrains IDE instance to enhance security during development. The plugin scans for security policy violations using both default and custom policies, allowing you to identify and resolve issues before committing code, reducing the risk of pull request failures due to undetected problems.

Note

The Cortex AppSec code security plugin supports all JetBrains products.

Supported scan categories

The plugin scans these code security categories:

• Secrets: Identifies sensitive data embedded in code, such as API keys, encryption keys, OAuth tokens, certificates, PEM files, passwords, and pass-phrases
• IaC misconfigurations in IaC templates such as Kubernetes and Terraform. For a list of supported IaC frameworks, see Supported frameworks and languages
• SCA vulnerabilities: Includes security issues in both direct and transitive open-source dependencies
• Licenses: Software license mis-compliance
• Package Integrity: Assesses the operational risk and potential impact of each package in your codebase

Prerequisites

• Permissions: CLI Read only permissions. Refer to Cortex CLI for more information about permissions
• Environment setup

  • macOS and Windows: Install Python 3.9.x to 3.12.x
  • Install Node.js version 22 and above for SCA scans (such as vulnerabilities scans)
• API key and URL: Generate an API access key and retrieve your URL for authentication purposes. See Retrieve your API key and URL.

Integration steps

Retrieve your API key and URL

Step 1

Generate and copy a Cortex Cloud access key to enable access to Cortex Cloud. The access key includes a key ID and secret:

1. Navigate to Settings → Configurations → API Keys (under Integrations) → + New Key.
2. Copy and save the key.
3. Retrieve your API Key ID from the ID column.

Important

When generating an API key, ensure you select the Standard security level. IDE and CLI scans will fail if the security level of the API key is set to Advanced.

For more information about API keys, see Cortex XSIAM API documentation.

For more information about Application Security APIs, refer to the Application Security API documentation.

Step 2

Retrieve your Cortex Cloud API URL: Navigate to Settings → Configurations → API Keys (under Integration) → click Copy API URL.

Installation

You can install the plugin directly through the JetBrains IDE Plugins panel or the JetBrains Marketplace.

• Install through JetBrains IDE: Navigate to Settings → Plugins → select the Marketplace tab → search for Cortex Cloud → Install → OK
• Install from the JetBrains marketplace:

  1. Open the marketplace.
  2. Select a platform, search for the Cortex Cloud plugin, and click Get.
  3. Select Download from the Versions tab and then Got it in the popup.

Configure plugin settings

1. In your IDE, select Settings → Tools → Cortex Cloud.
2. In the plugin Settings screen, fill in these fields:

   • Access Key: Your Cortex Cloud API key ID
   • Secret Key: Your Cortex Cloud API secret key
   • Cortex Cloud URL: Your Cortex Cloud URL.

     Danger

     You must insert your API key and API ID values into the Settings before providing the tenant URL.
   • CA-Certificate (optional): Add your CA certificate. Format: .pem file

     Example 2. Example

     • macOS/Linux: /Users/your_username/Documents/cacert.pem or ~/Documents/cacert.pem
     • Windows: C:\Users\your_username\Documents\cacert.pem
   • CLI Version: Leave blank to use the latest Cortex Cloud Application Security version (or enter 'latest'), or specify a version
   • CLI Path: Specifies the path to the CLI executable. Recommended: Leave empty to let the extension manage the CLI installation
   • Ignore gitignore files: Selected by default. Files that belongs to paths included in the • gitignore file will not be scanned when opened or saved
   • External Checks Directory: Provide the path to a folder containing custom security checks
   • Custom Environment Variables: Environment variables passed to the scanner during scans such as CORTEX_API_BASE_URL:

     • To add variables, provide the key/value pairs in the table under the Custom Environment Variables field
     • To remove variables, select the (—) sign
3. Click Apply → OK.

Test connection

You can test your connection by selecting the Test Connection field under Settings.