Visual Studio Code extension configuration, environment variables and proxy

Snyk Account

• Authentication method: Specifies whether to authenticate with OAuth2 or with an API token. OAuth2by default

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

• Organization: Sets the Organization 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 Organization in the Snyk UI: https://app.snyk.io/org/[orgslugname].

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

• Send error reports to Snyk: Helps Snyk to improve the plugin's stability by analyzing such reports

Scan Configuration

• Open Source: Enables a scanner for open source dependencies; enabled by default.

• Snyk Code Security issues: Enables a scanner for security vulnerabilities in your application code; enabled by default

• Snyk Code Quality issues: Enables a scanner for code quality issues in your application code; disabled by default.

• Infrastructure as Code: Enables a scanner for insecure configurations in Terraform and Kubernetes code; enabled by default.

• Severity selection: Filters issues by their severity (from Low to Critical)

• All Issues vs Net New Issues: Specifies whether to see all issues or only net new issues. The latter requires a Git repository, where it compares findings with those in the base branch.

• 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.

User Experience

• Scanning mode: The auto option activates automatic scans when saving files and when opening a Project; works with Code and IaC.

• Auto Scan Open Source Security: If set, runs Open Source Security analysis in automatic mode.

Experimental

This section contains experimental features that may change suddenly.

These settings are not part of the stable functionality and are not officially supported yet.

Initialization

• Trusted Folders links to the settings.json file, which has a list of folders that are marked as trusted. Use this setting only in advanced cases or when certain folders should be marked as not trusted.

CLI and Language Server

• When Automatic Dependency Management is checked, the plugin will download the Language Server and the CLI and update them regularly to the defined CLI path and Language Server path (if defined). 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 these dependencies through other means.

• CLI Path: Allows changing a file path of the Snyk CLI (optional field).

• Language Server Path: Allows changing a file path of the Snyk CLI (optional field).

Environment variables

To analyze Projects, the plugin uses the Snyk CLI which requires environment variables:

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

• JAVA_HOME: the path to the JDK you want 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 IDE from the command line or create a script file that starts the IDE 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 must know the environment variables to launch the IDE from the Finder directly. You can set environment variables for applications launched using the Finder by using the launchctl setenv command, for example, on start-up or through a script you launch at user login. Note that the provision of environment variables to the macOS UI can change between operating system releases, so it may be easier to create a small shell script that launches the IDE to leverage the shell environment that can be defined using ~/.bashrc.

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

Proxy

If you are behind a proxy, configure the proxy settings using VS Code proxy settings Application > Proxy or set the proxy settings using the http_proxy and https_proxy environment variables.

Example: The commonly used setting Proxy Strict SSL specifying that the proxy server certificate should be verified against the list of supplied CAs specific to Snyk Code.