dependency-track/docs/_docs/FAQ.md

128 lines
7.5 KiB
Markdown
Raw Normal View History

2020-03-11 12:03:39 +02:00
---
title: Frequently Asked Questions
category: FAQ
2020-03-11 12:12:31 +01:00
chapter: 10
2020-03-11 12:03:39 +02:00
order:
---
2020-03-18 23:30:47 +02:00
Frequently asked questions about Dependency Track functionality that may not be covered by the documentation. If you don't find an answer here, try reaching out to the Slack [channel](https://owasp.slack.com/archives/C6R3R32H4) related to dependency track.
2020-03-11 12:03:39 +02:00
#### Which domains must I allow in my firewall?
See [Which external services does Dependency-Track contact?](outbound-connections.md)
2020-03-11 12:03:39 +02:00
#### Dependency Check and Dependency Track Comparison
This topic is heavily explained in the [Dependency Check Comparison](./../odt-odc-comparison/) to Dependency Track.
#### I expect to see vulnerable components but I don't
Most common reason: You have yet to enable the [Sonatype OSS Index Analyzer]. It is not
enabled by default but is necessary to scan dependencies represented by
[Package URLs](./../terminology/#package-url-purl).
Authentication through API Token will be required. Follow [Sonatype OSS Index Analyzer] `Authentication` instructions.
2020-03-17 13:12:08 +01:00
#### I have just enabled OSS Index Analyzer but still don't see results
The analyzers run asynchronously. After you enable an analyzer it is not immediately run.
You have to wait some time until the analyzers are scheduled, currently this is 6 hours.
2020-12-26 23:27:00 -06:00
You can also trigger the analysis of one project by re-uploading a SBOM for the project.
2020-03-17 13:12:08 +01:00
Restarting Dependency Track will not run the analyzers either, it will just reset the clock.
#### Why is the local NVD mirror not used?
The local NVD mirror is used for dependencies that are identified by a [CPE](./../terminology/#cpe). These are mostly
components like operating systems, applications, and hardware. That's what CPE was designed to represent.
[Package URLs](./../terminology/#package-url-purl) (PURL) on the other hand are designed to represent all kinds of software
dependencies like packages, libraries, and frameworks. In the local mirror there is no mapping from the PURL to CPE/CVE.
So the local mirror is used, but not for dependencies represented by PURL. Dependency Track will use the Analyzer best
suited to analyze a given dependency.
#### The NVD CPE search is showing significantly more CVEs than Dependency-Track
The NVD allows users to [search CVEs by CPE](https://nvd.nist.gov/products/cpe/search). Naturally, users assume
that CVEs returned by this search mechanism are CVEs *affecting* the given CPE. When comparing the number of results
with those reported by Dependency-Track, it is common to find discrepancies. This does not necessarily mean that
Dependency-Track is missing CVEs that the NVD search is able to identify.
The NVD utilizes the concept of [Known Affected Software Configurations](https://nvd.nist.gov/vuln/vulnerability-detail-pages)
to express more complex matching criteria. For example, [CVE-2016-8963](https://nvd.nist.gov/vuln/detail/CVE-2016-8963)
affects `cpe:2.3:a:ibm:license_metric_tool:9.2.0:*:*:*:*:*:*:*` *running on* `cpe:2.3:o:linux:linux_kernel:*:*:*:*:*:*:*:*`.
The Linux Kernel itself is *not* affected. But when searching the NVD for `cpe:2.3:o:linux:linux_kernel:*:*:*:*:*:*:*:*`,
CVE-2016-8963 is returned as result.
Dependency-Track will only flag a component as vulnerable when it itself is vulnerable. If it is merely part of a
configuration like above, Dependency-Track will not report it as vulnerable.
2020-03-17 13:31:21 +01:00
#### Dependency Track crashes when run as a container
Make sure the container is allowed to allocate enough RAM. For memory requirements see
[Deploying Docker Container](./../getting-started/deploy-docker/). A common source for limited memory is Docker for
2021-08-03 10:01:41 -05:00
Windows's default memory limit of 2GB which is too little. You can change this in Docker's settings.
2020-03-17 13:31:21 +01:00
#### Dependency Track stops working after 1-2 weeks
This might happen if your OS cleans-up temp storage without checking for open files.
This has been observed with Windows and CentOS.
Deleting temporary files is a problem for the embedded Jetty server used by Dependency Track.
When launching Dependency Track, try adding `-Djava.io.tmpdir=/path/to/tmpdir` to the command and specify an
alternative path to where you want DT temp files to reside.
2020-03-18 23:30:47 +02:00
#### Why is there a delay with LDAP synchronization?
2020-12-26 23:27:00 -06:00
For auto-provisioned accounts, LDAP synchronization is performed on-demand and utilizes the same async job scheduling queue that all other jobs use. If the system is busy processing other jobs (mirroring the NVD or processing lots of SBOMs simultaneously for example), there might be a slight delay provisioning the account (which includes permission sync). If the LDAP account is manually created in DT, then synchronization has already happened and there shouldnt be a delay.
2020-03-18 23:32:48 +02:00
#### I'm seeing "PKIX path building failed" errors in the API server logs, what is that and how can I fix it?
2020-03-18 23:32:48 +02:00
Your Dependency-Track instance is most likely configured to connect to services that use TLS certificates
that are either self-signed, or signed by your organization's internal certificate authority.
Please refer to the [Internal Certificate Authority](./../getting-started/internal-ca/) documentation.
#### Unrelated vulnerabilities are reported as aliases, how can this be fixed?
This can be a problem either in the data that Dependency-Track ingests from any of the enabled vulnerability intelligence
sources, or a bug in the way Dependency-Track correlates this data. Some data sources have been found to not report
reliable alias data. As of v4.8.0, alias synchronization can be disabled on a per-source basis. For the time being,
it is recommended to disable alias synchronization for OSV and Snyk.
To reset alias data, do the following:
1. Disable alias synchronization for sources that may report unreliable data
2. Stop the API server application
3. Delete all aliases from the database:
```sql
DELETE FROM "VULNERABILITYALIAS" WHERE "ID" > 0;
```
4. Restart the API server application
Alias data will be re-populated the next time vulnerability intelligence sources are mirrored, or vulnerability
analysis is taking place. If this does not solve the problem, please raise a [defect report] on GitHub,
as it is likely a bug in Dependency-Track.
#### Received a 413 Request Entity Too Large error while uploading SBOM
If you encounter the `413 Request Entity Too Large` error while uploading SBOMs in your Kubernetes environment where
DependencyTrack is running served with nginx, you can try to expand the maximum upload size by including the subsequent annotations:
```yaml
nginx.ingress.kubernetes.io/proxy-body-size: "100m"
```
Please consult the [official documentation](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#custom-max-body-size)
#### Policy conditions do not work for some PURLs
Policy condition values are treated as regular expressions.
1. Policy condition values are implicitly treated as substring matches.
They must be explicitly anchored with `^` and `$` to make them an exact match.
2. Characters with special meaning in regular expressions should be escaped with a `\\`.
This is needed if the PURL contains a `?`, since the question mark makes the previous character optional and is not treated literally.
Another special character is `.`, which should also be escaped.
3. Policy condition values support wildcards, so an `*` means that any text is allowed, including missing text.
For example, `^vendor/*$` would match `vendor/lib-1`, `vendor/app`, or even only `vendor/`.
[defect report]: https://github.com/DependencyTrack/dependency-track/issues/new?assignees=&labels=defect%2Cin+triage&template=defect-report.yml
[Sonatype OSS Index Analyzer]: (./../datasources/ossindex/)