___ _____ _ _
/ _ \ |_ _| | | |
/ /_\ \_ __ _ __ | | | |__ _ __ ___ __ _| |_
| _ | '_ \| '_ \| | | '_ \| '__/ _ \/ _` | __|
| | | | |_) | |_) | | | | | | | | __/ (_| | |_
\_| |_/ .__/| .__/\_/ |_| |_|_| \___|\__,_|\__|
| | | |
|_| |_|
dep-scan is a fully open-source security audit tool for project dependencies based on known vulnerabilities, advisories and license limitations. The output is compatible with grafeas. The tool is ideal for CI environments with built-in build breaker logic.
If you have just come across this repo, probably the best place to start is to checkout the parent project (scan)[https://slscan.io] which include depscan along with a number of other tools.
- Package vulnerability scanning is performed locally and is quite fast. No server is used!
- Configurable
cache
andsync
functionality to manage local cache data - Pre-installed and integrated with scan
- Suggest optimal fix version by package group (See suggest mode)
dep-scan is ideal for use during continuous integration (CI) and also as a tool for local development.
dep-scan is integrated with scan, a free and open-source SAST tool. To enable this feature simply pass depscan
to the --type
argument. Refer to the scan documentation for more information.
---
--type python,depscan,credscan
This approach should work for all CI environments supported by scan.
npm install -g @appthreat/cdxgen
pip install appthreat-depscan
This would install two commands called cdxgen
and scan
.
You can invoke the scan command directly with the various options.
cd <project to scan>
scan --src $PWD --report_file $PWD/reports/depscan.json
appthreat/dep-scan
or quay.io/appthreat/dep-scan
container image can be used to perform the scan.
To scan with default settings
docker run --rm -v $PWD:/app appthreat/dep-scan scan --src /app --report_file /app/reports/depscan.json
To scan with custom environment variables based configuration
docker run --rm \
-e VDB_HOME=/db \
-e NVD_START_YEAR=2010 \
-e GITHUB_PAGE_COUNT=5 \
-e GITHUB_TOKEN=<token> \
-v /tmp:/db \
-v $PWD:/app appthreat/dep-scan scan --src /app --report_file /app/reports/depscan.json
In the above example, /tmp
is mounted as /db
into the container. This directory is then specified as VDB_HOME
for caching the vulnerability information. This way the database can be cached and reused to improve performance.
dep-scan uses cdxgen command internally to create Software Bill-of-Materials (SBoM) file for the project. This is then used for performing the scans.
The following projects and package-dependency format is supported by cdxgen.
Language | Package format |
---|---|
node.js | package-lock.json, pnpm-lock.yaml, yarn.lock, rush.js |
java | maven (pom.xml), gradle (build.gradle, .kts) |
scala | sbt |
php | composer.lock |
python | setup.py, requirements.txt, Pipfile.lock, poetry.lock |
go | go.sum, Gopkg.lock |
ruby | Gemfile.lock |
rust | Cargo.lock |
.Net core | .csproj |
NOTE
The docker image for dep-scan currently doesn't bundle suitable java and maven commands required for bom generation. To workaround this limitation, you can -
- Use python-based execution from a VM containing the correct versions for java, maven and gradle.
- Generate the bom file by invoking
cdxgen
command locally and subsequently passing this todep-scan
via the--bom
argument.
Refer to this example yaml configuration for integrating dep-scan with Azure Pipelines. The build step would perform the scan and display the report inline as shown below:
This tool can be used with GitHub Actions using this action.
This repo self-tests itself with both sast-scan and dep-scan! Check the GitHub workflow file of this repo.
- name: Self dep-scan
uses: AppThreat/dep-scan-action@master
env:
VDB_HOME: ${{ github.workspace }}/db
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
The following environment variables can be used to customise the behaviour.
- VDB_HOME - Directory to use for caching database. For docker based execution, this directory should get mounted as a volume from the host
- NVD_START_YEAR - Default: 2018. Supports upto 2002
- GITHUB_PAGE_COUNT - Default: 2. Supports upto 20
To download security advisories from GitHub, a personal access token with the following scope is necessary.
- read:packages
export GITHUB_TOKEN="<PAT token>"
Fix version for each vulnerability is retrieved from the sources. Sometimes, there might be known vulnerabilities in the fix version reported. Eg: in the below screenshot the fix versions suggested for jackson-databind might contain known vulnerabilities.
By passing an argument --suggest
it is possible to force depscan to recheck the fix suggestions. This way the suggestion becomes more optimal for a given package group.
Notice, how the new suggested version is 2.9.10.5
which is an optimal fix version. Please note that the optimal fix version may not be the appropriate version for your application based on compatibility.
dep-scan can automatically scan the dependencies for any license limitations and report them directly on the console log. The licenses data is sourced from choosealicense.com and is quite limited. If the license of a given package cannot be reliably matched against this list it will get silently ignored to reduce any noise. This behaviour could change in the future once the detection logic gets improved.
Dependency Check is considered to be the industry standard for open-source dependency scanning. After personally using this great product for a number of years I decided to write my own from scratch partly as a dedication to this project. By using a streaming database based on msgpack and using json schema, dep-scan is more performant than dependency check in CI environments. Plus with support for GitHub advisory source and grafeas report export and submission, dep-scan is on track to become a next-generation dependency audit tool
There are a number of other tools that piggy back on Sonatype ossindex API server. For some reason, I always felt uncomfortable letting a commercial company track the usage of various projects across the world. dep-scan is therefore 100% private and guarantees never to perform any tracking!