Java

• Scan their software for potential security issues and violations of organizational policy.
• Prioritize vulnerabilities in the context of their applications.
• Understand the relationships between software components in their applications.

​

System specifications for deep scan

​

Software prerequisites

• Install JDK versions between 11 and 25.0.2
  • For JDK 8, see Scan the projects on JDK version 8
• Make sure your repository includes one or more files with .java extension.
• Install Maven Package Manager version 3.6.1 and higher if your project uses Maven.
• Install Gradle build system version 6.0.0 and higher, if your project uses Gradle. To support lower versions of Gradle, see Scan projects on Gradle versions between 4.7 and 6.0.0.
• Install Bazel version 5.x.x, 6.x.x, 7.x.x, 8.x.x, or 9.x.x if your project uses Bazel. Endor Labs supports Bzlmod with Bazel aspects using rules_java >= 5.0.0. See Bazel for more information.
• For projects not using Maven or Gradle, make sure that your project is set up properly to scan without the pom.xml file. See Scan projects without pom.xml for more information.

​

Build Java projects

​

Use Gradle

1. If you would like to run a scan against a custom configuration, specify the Gradle configuration by setting an environment variable.
      export endorGradleJavaConfiguration="<configuration>"
   
   When no configuration is provided, endorctl uses runtimeClasspath by default. If neither the user-specified nor the default configuration exists in the project, endorctl falls back to the following configurations, in order:
   1. runtimeClasspath
   2. runtime
   3. compileClasspath
   4. compile
   If endorctl does not find the listed configurations in the project, it selects the first available configuration in alphabetical order.
2. Ensure that you can resolve the dependencies for your project without errors by running the following command: For Gradle wrapper:
      ./gradlew dependencies
   
   For Gradle:
      gradle dependencies
   
3. Run ./gradlew assemble or gradle assemble to resolve dependencies and create an artifact for deep analysis.

​

Override subproject level configuration

\--- Project ':samples'
     +--- Project ':samples:compare'
     +--- Project ':samples:crawler'
     +--- Project ':samples:guide'
     +--- Project ':samples:simple-client'
     +--- Project ':samples:slack'
     +--- Project ':samples:static-server'
     +--- Project ':samples:tlssurvey'
     \--- Project ':samples:unixdomainsockets'

1. Navigate to the root workspace, where you execute endorctl scan, and run ./gradlew projects to list all projects and their names.
2. Run the following command at the root of the workspace:
   echo ":samples:crawler=testRuntimeClasspath,:samples:guide=macroBenchMarkClasspath" >> .endorproperties
   
   This creates a new file named .endorproperties in your root directory. This enables different configurations for the specified subprojects in the file.
3. Run endorctl scan.

​

Configure private Gradle package repositories

​

Use Maven

1. Ensure that you can resolve the dependencies for your project without error by running the following command.
    mvn dependency:tree
   
2. Run mvn install and make sure the build is successful.
   If you want to skip the execution of tests during the build, you can use -DskipTests to quickly build and install your projects.
    mvn install -DskipTests
   
3. If you have multiple Java modules not referenced in the root pom.xml file, make sure to run mvn install separately in all the directories.

​

Configure private Maven package repositories

​

Scan Bazel projects

​

Run a scan

​

Option 1 - Quick scan

endorctl scan --quick-scan

endorctl scan --quick-scan -o json | tee /path/to/results.json

​

Option 2 - Deep scan

endorctl scan

endorctl scan -o json | tee /path/to/results.json

endorctl scan --disable-private-package-analysis

​

Scan projects without pom.xml

​

Uber jars

export ENDOR_JVM_USE_ARTIFACT_SCAN=true
endorctl scan --package --path=<jar/ear/war location> --project-name=<project name>

export ENDOR_JVM_USE_ARTIFACT_SCAN=true
endorctl scan --package --path=/Users/johndoe/projects/project21.jar --project-name=Project21

​

Application dependencies in classpath

export ENDOR_JVM_USE_ARTIFACT_SCAN=true
export ENDOR_JVM_USE_ARTIFACT_SCAN_CLASSPATH=<path that contains application depedencies>
endorctl scan --package --path=<jar/ear/war location> --project-name=<project name>

export ENDOR_JVM_USE_ARTIFACT_SCAN=true
export ENDOR_JVM_USE_ARTIFACT_SCAN_CLASSPATH=/Users/johndoe/caches/modules/files-2.1
endorctl scan --package --path=/Users/johndoe/projects/project21.jar --project-name=Project21

​

Scan the projects on JDK version 8

1. Build your Java project on JDK 8.
2. After building, switch your Java home to JDK 11 or higher versions.
   export JAVA_HOME=/Library/Java/JavaVirtualMachines/openjdk-11.jdk/Contents/Home
   
3. Run a scan

​

Scan projects on Gradle versions between 4.7 and 6.0.0

1. Check the version of your project using:
   ./gradlew --version
   
2. The project must have a Gradle wrapper. You can generate the Gradle wrapper using:
   --gradle-version <your required version>.
   
   Endor Labs prioritizes Gradle wrapper over Gradle and it is a recommended best practice to use Gradle Wrapper.
3. Before executing the endorctl scan, ensure the project can be built in your required version.
   Execute ./gradlew assemble.
   
4. Use --bypass-host-check during endorctl scan to execute scans on projects that have Gradle versions lower than 6.0.0.

​

Understand the scan process

​

How Endor Labs resolves dependencies for package versions

• For packages built using Maven, it leverages the Maven cache in the .m2 directory of your file system to resolve the package’s dependencies and mirrors Maven’s build process for the most accurate results.
• For Maven, Endor Labs respects the configuration settings in the settings.xml file. If your repository includes this file, you need not provide any additional configuration.
• For packages built using Gradle, it uses Gradle and Gradle wrapper files to build packages and resolve dependencies.
• Endor Labs supports EAR, JAR, RAR, and WAR files.

​

How Endor Labs performs static analysis on the code

• Endor Labs creates call graphs for your package and combines them with the dependency call graphs to form a comprehensive call graph for the entire project.
• Endor Labs performs an inside-out analysis of the software to determine the reachability of dependencies in your project.
• The static analysis time may vary depending on the number of dependencies in the package and the number of packages in the project.

​

Known limitations

• If a package can not be successfully built in the source control repository, static analysis will fail.
• Endor Labs analyzes Spring dependencies based on Spring public entry points to reduce the impact of Inversion of Control (IOC) frameworks. Endor Labs identifies dependencies and functions as reachable or unreachable in the context of a Spring version and its entry points.
• Annotation processing is limited only to the usage of the code they annotate.
• Static analysis of reflection and callbacks are not supported.
• Endor Labs requires JDK 11 to generate call graphs for Java projects. Gradle versions lacking JDK 11 support are not compatible.

​

Troubleshoot errors

• Host system check failure errors:
  • Java is not installed or not present in the PATH environment variable. Install Java and try again. See Java documentation for more information.
  • The installed version of Java is lower than the required version. Install JDK versions between 11-25.0.2 and try again.
  • Java is installed but Maven or Gradle is not installed. In such cases, the dependency resolution may not be complete.
• Unresolved dependency errors: Maven is not installed properly or the system is unable to build root pom.xml. Run mvn dependency:tree in the root of the project and try again. In such cases, the dependency resolution may not be complete.
• Resolved dependency errors: A dependency version does not exist or cannot be found. The package may no longer exist in the repository.
• Gradle variant incompatibility message: Gradle performs JVM toolchain checks for subprojects or dependencies and may raise errors indicating a Java version mismatch between dependencies declared in Gradle manifest and Java home setup. Example error message: Incompatible because this component declares a component for use during compile-time, compatible with Java version 21 and the consumer needed a component for use during runtime, compatible with Java version 17
  • To resolve this, use Java’s backward compatibility and instruct Gradle to use the higher JDK version from the error message. Specify org.gradle.java.home=<path of java> in .gradle/gradle.properties. The path must point to the root of the directory containing bin/java. For example, if your Java is at /Users/Downloads/jdk-21/Contents/Home/bin/java, specify org.gradle.java.home=/Users/Downloads/jdk-21/Contents/Home.
  • If you are scanning a purely Java 8 Gradle project and if you encounter the above error, set org.gradle.java.home to point to Java 8 home, before you execute the endorctl scan.
  • A general guideline for determining which Java version to use, is to match the Java version specified in .gradle/gradle.properties with the one used for building your Gradle project.
• Call graph errors:
  • endorctl cannot build the project because it cannot locate a dependency in the repository.
  • Sometimes the build fails if a Java version discrepancy exists between the required repository version and the version on the system running the scan. For example, the Java required version is 1.8 but the system has 12 installed. Install the required version and try again.
• If you have a private registry and internal dependencies on other projects, you must configure the credentials of the registry. See Configure Maven private registries.
• If you have a large repository or if the scan fails with out-of-memory issues, you may need to increase the JVM heap size before you can successfully scan. Export the ENDOR_SCAN_JVM_PARAMETERS environment variable with additional JVM parameters before performing the scan as shown below:
  export ENDOR_SCAN_JVM_PARAMETERS="-Xmx32G"
  
• If you use a remote repository configured to authenticate with a client-side certificate, you must add the certificate through an endorctl parameter. Export the ENDOR_SCAN_JVM_PARAMETERS parameter before performing a scan. See Maven documentation for details.
  export ENDOR_SCAN_JVM_PARAMETERS="-Xmx16G,-Djavax.net.ssl.keyStorePassword=changeit,
  -Djavax.net.ssl.keyStoreType=pkcs12,
  -Djavax.net.ssl.keyStore=/Users/myuser/Documents/nexustls/client-cert1.p12"