Snyk for Java and Kotlin
Snyk offers security scanning to test your projects for vulnerabilities, both from the Snyk CLI and the Snyk Web UI using different Snyk Integrations.
The following tables provide an outline of the general features Snyk offers by language. In addition to these features, Snyk offers additional functionality related to the specific integration configurations.
Some features might not be available, depending on your pricing plan. See pricing plans for more details.
Gradle projects imported via Git are tested by parsing
build.gradle files. As the only truly reliable way to resolve Gradle dependencies is to execute the tool itself, this method can sometimes provide incomplete results.- Git - Maven
3.*
- Git - Gradle
4.*,5.*,6.*
The way Snyk analyzes and builds the dependencies varies depending on the language and package manager of the Project.
The Snyk CLI tests Maven and Gradle Projects as follows:
- Snyk CLI with Gradle: To build the dependency graph, Snyk integrates with Gradle and inspects the dependencies returned by the build. The following manifest files are supported:
build.gradle(Groovy DSL) andbuild.gradle.kts(Kotlin DSL). - Snyk CLI with Maven: To build the dependency tree, Snyk analyzes the output of the
pom.xmlfiles.
This section describes the unique CLI commands available when working with Java-based Projects.
- Install the relevant package manager before you use the Snyk CLI.
- Include the relevant manifest files supported by Snyk before testing.
- Install and authenticate the Snyk CLI to start analyzing Projects from your local environment. See Getting started with the CLI.
For information about the
snyk test and snyk monitor options available for use with Maven and Gradle, see the following pages:Test a specific Maven profile called “prod”.
snyk test -- -prod
Add a system property from your pom.xml file.
Example:
The package version appears in your pom.xml
${pkg_version}
Define the system property like this:
snyk test -- -Dpkg_version=1.4
A Maven aggregate project is one that uses modules and inheritance.
When scanning these types of projects Snyk performs a compile to ensure all modules are resolvable by the Maven reactor.
- To scan aggregate projects, use the
--maven-aggregate-projectoption:snyk test --maven-aggregate-project - To scan non-aggregate projects use
--all-projectsoption:snyk test --all-projects
The same options can be used with
snyk monitor.Make sure to execute the options in the same directory as the root pom.xml file.
Each of the individual sub-projects appears as a separate Snyk Project in the Web UI.
Gradle build can consist of several sub-projects, where each sub-project has its own build.gradle, while the root project is the only one that also includes a
settings.gradle file. Sub-projects depend on the root project, but can be configured otherwise.By default, Snyk CLI scans only the current project (the project in the root of the current folder), or the project that is specified by
--file=path/to/build.gradle).- To scan all projects at once (recommended), use the
--all-sub-projectsoption:snyk test --all-sub-projects
Each of the individual sub-projects appears as a separate Snyk Project in the Web UI.
- To scan a specific project (for example, myapp):snyk test --sub-project=myapp
Gradle dependencies are declared for a particular scope; each scope is represented by Gradle with the help of Configurations. For example:
- compileOnly configuration for development dependencies
- compile configuration that includes compile and runtime dependencies
By default Snyk merges all configurations returned by Gradle to a dependency graph based on the sum total of the dependencies across all configurations in the Project or Projects.
To test a specific configuration:
- Use the
--configuration-matchingoption with a Java regular expression (case-insensitive) as its parameter. The configuration that matches is then tested. If several configurations match, they are all merged and resolved together. For example:'^releaseRuntimeClasspath$|^compile$' - If the different sub-projects include different configurations, scan each sub-project separately.
--configuration-matching=compilewill match compile, testCompile, compileOnly and so on.--configuration-matching=^compile$will match only compile.--configuration-matching='^(debug|release)compile$'will match debugCompile and releaseCompile.--configuration-matching='^(?!.*test).*$'will match all configurations except those containing the string "test".
Because the Snyk default behavior is to merge all available configurations, the iterated variants cause a clash of configurations that can't be merged.
In these situations, the Snyk scan fails with an error from Gradle which may contain one of the following messages:
- Cannot choose between the following configurations of
project :mymodulewithvariants - Cannot choose between the following variants of
project :mymodulewithvariants - Could not select value from candidates
To avoid such conflicts:
- Use a specific configuration(s): if you know of a build configuration that has all the required attributes and the configuration is identical across all sub-projects included in the test, specify that configuration. For example:--configuration-matching=prodReleaseRuntimeClasspath
- Explicitly specify the dependency configuration: modify intra-project dependencies in your build.gradle file(s) to use a specific configurationdependencies {implementation project(path: ':mymodulewithvariants', configuration: 'default')}
- Suggest configuration attributes: if you receive an error when running the command, the error may indicate which attribute values are available, while the error details from Gradle also indicate which dependency variants match which attributes. Using these details, add the attribute filter option. For example:snyk test --configuration-attributes=buildtype:release,usage:java-runtime,mode:demomatches the variants using
com.android.build.api.attributes.BuildTypeAttr=releaseandorg.gradle.usage=java-runtime
By default, Snyk passes
gradle build --no-daemon in the background when running snyk test and snyk monitor on Windows. If for some reason you see snyk test or snyk monitor fail on other operating systems because of daemon-related issues, try adding the --no-daemon flag to the Snyk command or set GRADLE_OPTS: '-Dorg.gradle.daemon=false'. See the Gradle documentation for tips on disabling the daemon.If your Gradle project makes use of a single gradle.lockfile or multiple *.lockfile per configuration and you are having the following issue
Gradle Error (short): > Could not resolve all dependencies for configuration ':compileOnly'. > Locking strict mode: Configuration ':compileOnly' is locked but does not have lock state.
Note that that compileOnly configuration has been deprecated and even if your Project successfully generates a lockfile, it will not contain the `compileOnly` state because this configuration cannot be resolved. Only resolvable configurations compute a dependency graph. In order to solve this issue, Snyk suggests you update your build.gradle containing dependencyLocking logic with the following instruction:
compileOnly {resolutionStrategy.deactivateDependencyLocking() }
This will ignore compileOnly and save only the necessary information to analyze your Project of Projects.
If you are having any trouble testing your Gradle projects with Snyk, collect the following details and send them to Snyk at [email protected]:
build.gradlesettings.gradle(especially if Snyk did not pick up a version of a package)- The output from the following commands:
$ snyk test -d$ gradle dependencies -q
After you select a project for import, Snyk builds the dependency tree based on the
pom.xml file.After you select a project for import, Snyk builds the dependency tree based on the
build.gradle file and (optional) gradle.lockfile.Only dependencies in the following configurations are included -
api, compile, classpath, implementation, runtime, runtimeOnly.If a lockfile is present, Snyk uses the lockfile to more accurately resolve the final version of dependencies used in the Project.
Gradle lockfiles are an opt-in feature that, among other benefits, enable reproducible builds. For more information see the Gradle docs on dependency locking.
Kotlin:
build.gradle.kts files are not currently supported in Git.From the Snyk UI you can specify mirrors or repositories from which you’d like to resolve packages in Artifactory for Maven. For more information see Artifactory Registry for Maven.
In addition to the CLI and Snyk UI features, you can also check your Java Projects using Maven integration.
Last modified 5d ago