xuacker/dependency-track

Dependency-Track is an intelligent Software Supply Chain Component Analysis platform that allows organizations to identify and reduce risk from the use of third-party and open source components. Dependency-Track takes a unique and highly beneficial approach by leveraging the capabilities of Software Bill-of-Materials (SBOM). This approach provides capabilities that traditional Software Composition Analysis (SCA) solutions cannot achieve.

Dependency-Track monitors component usage across all versions of every application in its portfolio in order to proactively identify risk across an organization. The platform has an API-first design and is ideal for use in Continuous Integration (CI) and Continuous Delivery (CD) environments.

Ecosystem Overview

Features

Tracks application, library, framework, operating system, and hardware components
Tracks component usage across all version of every application in an organizations portfolio
Identifies multiple forms of risk including
- Components with known vulnerabilities
- Out-of-date components
- Modified components
- License risk
- More coming soon...
Integrates with multiple sources of vulnerability intelligence including:
- National Vulnerability Database (NVD)
- NPM Public Advisories
- Sonatype OSS Index
- VulnDB from Risk Based Security
- More coming soon.
Ecosystem agnostic with built-in repository support for:
- Gems (Ruby)
- Hex (Erlang/Elixir)
- Maven (Java)
- NPM (Javascript)
- NuGet (.NET)
- Pypi (Python)
- More coming soon.
Includes a comprehensive auditing workflow for triaging results
Configurable notifications supporting Slack, Microsoft Teams, Webhooks, and Email
Supports standardized SPDX license ID’s and tracks license use by component
Supports importing CycloneDX and SPDX Software Bill-of-Materials (SBOM) formats
Easy to read metrics for components, projects, and portfolio
Native support for Kenna Security, Fortify SSC, and ThreadFix
API-first design facilitates easy integration with other systems
API documentation available in OpenAPI format
Supports internally managed users, Active Directory/LDAP, and API Keys
Simple to install and configure. Get up and running in just a few minutes

Distributions

Dependency-Track supports the following three deployment options:

Docker container
Executable WAR
Conventional WAR

NOTICE: Always use official binary releases in production.

Deploying Docker Container

Deploying with Docker is the easiest and fastest method of getting started. No prerequisites are required other than an modern version of Docker. Dependency-Track uses the following conventions:

The 'latest' tag, which is pulled by default if no tag is specified, will always refer to the latest stable release (3.0.0, 3.0.1, 3.1.0, etc)
The 'snapshot' tag will be built and pushed on all CI changes to the master. Use this if you want a "moving target" with all the latest changes.
Version tags (3.0.0, 3.0.1, etc) are used to indicate each release

docker pull owasp/dependency-track
docker volume create --name dependency-track
docker run -d -p 8080:8080 --name dependency-track -v dependency-track:/data owasp/dependency-track

To run snapshot releases (not recommended for production):

docker pull owasp/dependency-track:snapshot
docker volume create --name dependency-track
docker run -d -p 8080:8080 --name dependency-track -v dependency-track:/data owasp/dependency-track:snapshot

In the event you want to delete all Dependency-Track images, containers, and volumes, the following statements may be executed. NOTE: This is a destructive operation and cannot be undone.

docker rmi owasp/dependency-track
docker rm dependency-track
docker volume rm dependency-track:/data

Deploying on Kubernetes with Helm

You can install on Kubernetes using the community-maintained chart like this:

helm repo add evryfs-oss https://evryfs.github.io/helm-charts/
helm install evryfs-oss/dependency-track --name dependency-track --namespace dependency-track

by default it will install PostgreSQL and use persistent volume claims for the data-directory used for vulnerability feeds.

Deploying the Executable WAR

Another simple way to get Dependency-Track running quickly is to automatically deploy the executable WAR. This method requires Java 8u101 or higher. Simply download dependency-track-embedded.war and execute:

java -Xmx4G -jar dependency-track-embedded.war

Deploying the Conventional WAR

This is the most difficult to deploy option as it requires an already installed and configured Servlet container such as Apache Tomcat 8.5 and higher, however, it offers the most flexible deployment options. Follow the Servlet containers instructions for deploying dependency-track.war.

Compiling From Sources (optional)

To create an executable WAR that is ready to launch (recommended for most users):

mvn clean package -P embedded-jetty

To create a WAR that must be manually deployed to a modern Servlet container (i.e. Tomcat 8.5+):

mvn clean package

To create an executable WAR that is ready to be deployed in a Docker container:

mvn clean package -P embedded-jetty -Dlogback.configuration.file=src/main/docker/logback.xml

Resources

Website: https://dependencytrack.org/
Documentation: https://docs.dependencytrack.org/
Component Analysis: https://owasp.org/www-community/Component_Analysis

Community

Twitter: https://dependencytrack.org/twitter
YouTube: https://dependencytrack.org/youtube
Slack: https://dependencytrack.org/slack (Invite: https://dependencytrack.org/slack/invite)
Discussion (Groups.io): https://dependencytrack.org/discussion

Copyright & License

Permission to modify and redistribute is granted under the terms of the Apache License 2.0 license-url

Dependency-Track makes use of several other open source libraries. Please see the [NOTICES.txt] notices file for more information.

xuacker / dependency-track