Identify Java nested dependencies with Amazon Inspector SBOM Generator
Amazon Inspector is an automated vulnerability management service that continually scans Amazon Web Services (AWS) workloads for software vulnerabilities and unintended network exposure. Amazon Inspector currently supports vulnerability reporting for Amazon Elastic Compute Cloud (Amazon EC2) instances, container images stored in Amazon Elastic Container Registry (Amazon ECR), and AWS Lambda.
<p>Java archive files (JAR, WAR, and EAR) are widely used for packaging Java applications and libraries. These files can contain various dependencies that are required for the proper functioning of the application. In some cases, a JAR file might include other JAR files within its structure, leading to nested dependencies. To help maintain the security and stability of Java applications, you must identify and manage nested dependencies.</p>
<p>In this post, I will show you how to navigate the challenges of uncovering nested Java dependencies, guiding you through the process of analyzing JAR files and uncovering these dependencies. We will focus on the vulnerabilities that Amazon Inspector identifies using the <a href="https://docs.aws.amazon.com/inspector/latest/user/sbom-generator.html" target="_blank" rel="noopener">Amazon Inspector SBOM Generator</a>.</p>
<h2>The challenge of uncovering nested Java dependencies</h2>
<p>Nested dependencies in Java applications can be outdated or contain known vulnerabilities linked to <a href="https://www.cve.org/" target="_blank" rel="noopener">Common Vulnerabilities and Exposures (CVEs)</a>. A crucial issue that customers face is the tendency to overlook nested dependencies during analysis and triage. This oversight can lead to the misclassification of vulnerabilities as false positives, posing a security risk.</p>
<p>This challenge arises from several factors:</p>
<ul>
<li><strong>Volume of vulnerabilities</strong> — When customers encounter a high volume of vulnerabilities, the sheer number can be overwhelming, making it challenging to dedicate sufficient time and resources to thoroughly analyze each one.</li>
<li><strong>Lack of tools or insufficient tooling</strong> — There is often a gap in the available tools to effectively identify nested dependencies (for example, <a href="https://maven.apache.org/plugins/maven-dependency-plugin/tree-mojo.html" target="_blank" rel="noopener">mvn dependency:tree</a>, <a href="https://owasp.org/www-project-dependency-check/" target="_blank" rel="noopener">OWASP Dependency-Check</a>). Without the right tools, customers can miss critical dependencies hidden deep within their applications.</li>
<li><strong>Understanding the complexity</strong> — Understanding the intricate web of nested dependencies requires a specific skill set and knowledge base. Deficits in this area can hinder effective analysis and risk mitigation.</li>
</ul>
<h2>Overview of nested dependencies</h2>
<p>Nested dependencies occur when a library or module that is required by your application relies on additional libraries or modules. This is a common scenario in modern software development because developers often use third-party libraries to build upon existing solutions and to benefit from the collective knowledge of the open-source community.</p>
<p>In the context of JAR files, nested dependencies can arise when a JAR file includes other JAR files as part of its structure. These nested files can have their own dependencies, which might further depend on other libraries, creating a chain of dependencies. Nested dependencies help to modularize code and promote code reuse, but they can introduce complexity and increase the potential for security vulnerabilities if they aren’t managed properly.</p>
<h3>Why it’s important to know what dependencies are consumed in a JAR file</h3>
<p>Consider the following examples, which depict a typical file structure of a Java application to illustrate how nested dependencies are organized:</p>
<h4 id="example_1">Example 1 — Log4J dependency</h4>
<div class="hide-language">
<pre class="unlimited-height-code"><code class="lang-text">MyWebApp/
|– mywebapp-1.0-SNAPSHOT.jar
| |– spring-boot-3.0.2.jar
| | |– spring-boot-autoconfigure-3.0.2.jar
| | | |– …
| | | | |– log4j-to-slf4j.jar
This structure includes the following files and dependencies:</p>
<ul>
<li><span>mywebapp-1.0-SNAPSHOT.jar</span> is the main application JAR file.</li>
<li>Within <span>mywebapp-1.0-SNAPSHOT.jar</span>, there’s <span>spring-boot-3.0.2.jar</span>, which is a dependency of the main application.</li>
<li>Nested within <span>spring-boot-3.0.2.jar</span>, there’s <span>spring-boot-autoconfigure-3.0.2.jar</span>, a transitive dependency.</li>
<li>Within <span>spring-boot-autoconfigure-3.0.2.jar</span>, there’s <span>log4j-to-slf4j.jar</span>, which is our nested <a href="https://logging.apache.org/log4j/2.x/" target="_blank" rel="noopener">Log4J</a> dependency.</li>
</ul>
<p>This structure illustrates how a Java application might include nested dependencies, with Log4J nested within other libraries. The actual nesting and dependencies will vary based on the specific libraries and versions that you use in your project.</p>
<h4 id="example_2">Example 2 — Jackson dependency</h4>
<div class="hide-language">
<pre class="unlimited-height-code"><code class="lang-text">MyFinanceApp/
|– myfinanceapp-2.5.jar
| |– jackson-databind-2.9.10.jar
| | |– jackson-core-2.9.10.jar
| | | |– …
| | |– jackson-annotations-2.9.10.jar
| | | |– …
This structure includes the following files and dependencies:
- myfinanceapp-2.5.jar is the primary application JAR file.
- Within myfinanceapp-2.5.jar, there is jackson-databind-2.9.10.1.jar, which is a library that the main application relies on for JSON processing.
- Nested within jackson-databind-2.9.10.1.jar, there are other Jackson components such as jackson-core-2.9.10.jar and jackson-annotations-2.9.10.jar. These are dependencies that jackson-databind itself requires to function.
This structure is an example for Java applications that use Jackson for JSON operations. Because Jackson libraries are frequently updated to address various issues, including performance optimizations and security fixes, developers need to be aware of these nested dependencies to keep their applications up-to-date and secure. If you have detailed knowledge of where these components are nested within your application, it will be easier to maintain and upgrade them.
Example 3 — Hibernate dependency
This structure includes the following files and dependencies:
- myerpsystem-3.1.jar as the primary JAR file of the application.
- Within myerpsystem-3.1.jar, hibernate-core-5.4.18.Final.jar serves as a dependency for object-relational mapping (ORM) capabilities.
- Nested dependencies such as hibernate-validator-6.1.5.Final.jar and hibernate-entitymanager-5.4.18.Final.jar are crucial for the validation and entity management functionalities that Hibernate provides.
In instances where MyERPSystem encounters operational issues due to a mismatch between the Hibernate versions and another library (that is, a newer version of Spring expecting a different version of Hibernate), developers can use the detailed insights that Amazon Inspector SBOM Generator provides. This tool helps quickly pinpoint the exact versions of Hibernate and its nested dependencies, facilitating a faster resolution to compatibility problems.
Here are some reasons why it’s important to understand the dependencies that are consumed within a JAR file:
- Security — Nested dependencies can introduce vulnerabilities if they are outdated or have known security issues. A prime example is the Log4J vulnerability discovered in late 2021 (CVE-2021-44228). This vulnerability was critical because Log4J is a widely used logging framework, and threat actors could have exploited the flaw remotely, leading to serious consequences. What exacerbated the issue was the fact that Log4J often existed as a nested dependency in various Java applications (see Example 1), making it difficult for organizations to identify and patch each instance.
- Compliance — Many organizations must adhere to strict policies about third-party libraries for licensing, regulatory, or security reasons. Not knowing the dependencies, especially nested ones such as in the Log4J case, can lead to non-compliance with these policies.
- Maintainability — It’s crucial that you stay informed about the dependencies within your project for timely updates or replacements. Consider the Jackson library (Example 2), which is often updated to introduce new features or to patch security vulnerabilities. Managing these updates can be complex, especially when the library is a nested dependency.
- Troubleshooting — Identifying dependencies plays a critical role in resolving operational issues swiftly. An example of this is addressing compatibility issues between Hibernate and other Java libraries or frameworks within your application due to version mismatches (Example 3). Such problems often manifest as unexpected exceptions or degraded performance, so you need to have a precise understanding of the libraries involved.
These examples underscore that you need to have deep visibility into JAR file contents to help protect against immediate threats and help ensure long-term application health and compliance.
Existing tooling limitations
When analyzing Java applications for nested dependencies, one of the main challenges is that existing tools can’t efficiently narrow down the exact location of these dependencies. This issue is particularly evident with tools such as mvn dependency:tree, OWASP Dependency-Check, and similar dependency analysis solutions.
Although tools are available to analyze Java applications for nested dependencies, they often fall short in several key areas. The following points highlight common limitations of these tools:
- Inadequate depth in dependency trees — Although other tools provide a hierarchical view of project dependencies, they often fail to delve deep enough to reveal nested dependencies, particularly those that are embedded within other JAR files as nested dependencies. Nested dependencies are repackaged within a library and aren’t immediately visible in the standard dependency tree.
- Lack of specific location details — These tools typically don’t offer the granularity needed to pinpoint the exact location of a nested dependency within a JAR file. For large and complex Java applications, it may be challenging to identify and address specific dependencies, especially when they are deeply embedded.
- Complexity in large projects — In projects with a vast and intricate network of dependencies, these tools can struggle to provide clear and actionable insights. The output can be complicated and difficult to navigate, leaving customers without a clear path to identifying critical dependencies.
Address tooling limitations with Amazon Inspector SBOM Generator
The Amazon Inspector SBOM Generator (Sbomgen) introduces a significant advancement in the identification of nested dependencies in Java applications. Although the concept of monitoring dependencies is well-established in software development, AWS has tailored this tool to enhance visibility into the complexities of software compositions. By generating a software bill of materials (SBOM) for a container image, Sbomgen provides a detailed inventory of the software installed on a system, including hidden nested dependencies that traditional tools can overlook. This capability enriches the existing toolkit, offering a more granular and actionable understanding of the dependency structure of your applications.
Sbomgen works by scanning for files that contain information about installed packages. Upon finding such files, it extracts essential data such as package names, versions, and other metadata. Then it transforms this metadata into a CycloneDX SBOM, providing a structured and detailed view of the dependencies.
For information about how to install Sbomgen, see Installing Amazon Inspector SBOM Generator (Sbomgen)
A key feature of Sbomgen is its ability to provide explicit paths to each dependency.
For example, given a compiled jar application MyWebApp-0.0.1-SNAPSHOT.jar, users can run the following CLI command with Sbomgen:
The output should look similar to the following:
In this output, the amazon:inspector:sbom_collector:path property is particularly significant. It provides a clear and complete path to the location of the specific dependency (in this case, log4j-to-slf4j) within the application’s structure. This level of detail is crucial for several reasons:
- Precise location identification — It helps you quickly and accurately identify the exact location of each dependency, which is especially useful for nested dependencies that are otherwise hard to locate.
- Effective risk management — When you know the exact path of dependencies, you can more efficiently assess and address security risks associated with these dependencies.
- Time and resource efficiency — It reduces the time and resources needed to manually trace and analyze dependencies, streamlining the vulnerability management process.
- Enhanced visibility and transparency — It provides a clearer understanding of the application’s dependency structure, contributing to better overall management and maintenance.
- Comprehensive package information — The detailed package information, including name, version, hashes, and package URL, of Sbomgen equips you with a thorough understanding of each dependency’s specifics, aiding in precise vulnerability tracking and software integrity verification.
Mitigate vulnerable dependencies
After you identify the nested dependencies in your Java JAR files, you should verify whether these dependencies are outdated or vulnerable. Amazon Inspector can help you achieve this by doing the following:
- Comparing the discovered dependencies against a database of known vulnerabilities.
- Providing a list of potentially vulnerable dependencies, along with detailed information about the associated CVEs.
- Offering recommendations on how to mitigate the risks, such as updating the dependencies to a newer, more secure version.
By integrating Amazon Inspector into your software development lifecycle, you can continuously monitor your Java applications for vulnerable nested dependencies and take the necessary steps to help ensure that your application remains secure and compliant.
Conclusion
To help secure your Java applications, you must manage nested dependencies. Amazon Inspector provides an automated and efficient way to discover and mitigate potentially vulnerable dependencies in JAR files. By using the capabilities of Amazon Inspector, you can help improve the security posture of your Java applications and help ensure that they adhere to best practices.
If you have feedback about this post, submit comments in the Comments section below. If you have questions about this post, contact AWS Support.
<!-- '"` -->