Configuration, environment variables, and proxy for the JetBrains plugins

JetBrains plugin configuration

After the plugin is installed, you can opt out of downloading the CLI through the plugin and thus use your own installation of the CLI.

You can set the following configurations for the plugin, using Preferences → Tools → Snyk:

• Token: Set the token that should be used for authentication with Snyk (see Authentication for the JetBrains plugins).

• Custom endpoint: Specify the Snyk API endpoint for custom multi-tenant or single-tenant setup, The default is https://api.snyk.io. For details, see IDE URLs.

• Ignore unknown CA: Ignore the SSL cert, if needed

• Organization: Set the org to run snyk test against (similar to the --org= option in the CLI). Snyk recommends using the ORG_ID. If you specify an Organization slug name, the value must match the URL slug as displayed in the URL of your org in the Snyk UI: https://app.snyk.io/org/[orgslugname].

  If not specified, the preferred Organization, as defined in your web account settings, is used to run tests.

• Additional parameters: Set additional snyk test CLI options for Open Source scanning.

  For unmanaged C/C++ scanning, use the CLI option --unmanaged to find vulnerabilities in open-source packages. This option works only for unmanaged C/C++ scanning; do not use this option for other languages. Additional parameters do not apply to Snyk Code or IaC.

• Snyk Open Source: Use to analyze the project for open source vulnerabilities through the CLI using Snyk Open Source; enabled by default.

• Snyk Infrastructure as Code: Use to analyze the project for insecure configurations in Terraform and Kubernetes code; enabled by default.

• Snyk Container vulnerabilities: Use to analyze the project for container vulnerabilities in container images and Kubernetes applications; enabled by default.

• Snyk Code Security issues: Use to analyze the project for security vulnerabilities in your application code using Snyk Code; enabled by default

• Snyk Code Quality issues: Applies to Snyk Code only; disabled by default.

• Automatically manage needed binaries and Cli Path: Opt out of downloading the CLI through the plugin and thus use your own installation of the CLI.

  • CLI Path specifies where the plugin searches for the CLI.

  • When Automatically manage needed binaries is checked, the plugin will download the CLI and updates regularly to the defined CLI Path. Uncheck this option if downloading the CLI is not possible due to your network configuration (for example, due to firewall rules), and you need to obtain the CLI through other means.

  • Base URL allows you to specify alternative download locations of the CLI. These locations must conform to the same file and folder layout as https://static.snyk.io. For example, FIPS-supported CLIs would use the base URL https://static.snyk.io/fips.

  • CLI release channel allows you to specify a release channel (preview, rc, stable) for the CLI. You can also pin the CLI to a version here, specifying the version, e.g. v1.1293.0.

Path to Snyk CLI setting

• Scan automatically on start-up and save if enabled activates automatic scans when saving files and when opening a project.

Environment variables for the JetBrains plugins

To analyze Projects, the plugin uses the Snyk CLI which needs the following environment variables depending on the type of project you analyze:

• PATH: the path to needed binaries, for example, to maven

• JAVA_HOME: the path to the JDK to use to analyze Java dependencies

Setting these variables only in a shell environment (for example, using ~/.bashrc) is not sufficient, if you do not start the JetBrains IDE from the command line or create a script file that starts it using a shell environment.

• On Windows, you can set the variables, using the GUI or on the command line using the setx tool.

• On macOS, the process launchd needs to know the environment variables if you want to launch the IDE from Finder directly. Set environment variables for applications launched using Finder by running the launchctl setenv command. You can do this start-up or by using a script you launch at user login. Note: The provision of environment variables to the macOS UI can change between operating system releases, so it can be easier to create a small shell script that launches the IDE to leverage the shell environment, which can be defined using~/.bashrc.

• On Linux, updating the file /etc/environment can be used to propagate the environment variables to the windows manager and UI.

Proxy for the JetBrains plugins

If you need to use a proxy server to connect to the internet, configure it using the Jetbrains IDE settings. The Snyk plugin will use the settings.