Skip to content

Commit 2f875d2

Browse files
[EDI] Troubleshooting the detection of vulnerable dependencies / Troubleshooting Dependabot errors (#59710)
Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
1 parent cc235ce commit 2f875d2

File tree

7 files changed

+332
-247
lines changed

7 files changed

+332
-247
lines changed

content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ contentType: how-tos
1010
redirect_from:
1111
- /code-security/dependabot/troubleshooting-dependabot
1212
children:
13-
- /troubleshooting-the-detection-of-vulnerable-dependencies
1413
- /dependabot-updates-stopped
1514
- /troubleshooting-the-dependency-graph
1615
- /troubleshooting-dependabot-on-github-actions

content/code-security/reference/supply-chain-security/dependabot-errors.md

Lines changed: 0 additions & 231 deletions
This file was deleted.

content/code-security/reference/supply-chain-security/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ children:
2525
- /dependabot-security-updates
2626
- /dependency-graph-supported-package-ecosystems
2727
- /dependabot-on-actions
28-
- /dependabot-errors
28+
- /troubleshoot-dependabot
2929
redirect_from:
3030
- /code-security/dependabot/ecosystems-supported-by-dependabot
3131
---

content/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependabot-errors.md

Lines changed: 294 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Troubleshoot Dependabot
3+
shortTitle: Troubleshoot {% data variables.product.prodname_dependabot %}
4+
intro: Resolve dependency security issues with error codes, diagnostic information, and solutions for common problems.
5+
versions:
6+
fpt: '*'
7+
ghes: '*'
8+
ghec: '*'
9+
topics:
10+
- Dependabot
11+
- Version updates
12+
- Repositories
13+
- Dependencies
14+
- Pull requests
15+
- Dependency graph
16+
- Alerts
17+
- Vulnerabilities
18+
contentType: reference
19+
children:
20+
- /vulnerable-dependency-detection
21+
- /dependabot-errors
22+
---

content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-the-detection-of-vulnerable-dependencies.md renamed to content/code-security/reference/supply-chain-security/troubleshoot-dependabot/vulnerable-dependency-detection.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Troubleshooting the detection of vulnerable dependencies
2+
title: Vulnerable dependency detection
33
intro: If the dependency information reported by {% data variables.product.github %} is not what you expected, there are a number of points to consider, and various things you can check.
44
shortTitle: Troubleshoot vulnerability detection
55
redirect_from:
@@ -8,6 +8,7 @@ redirect_from:
88
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies
99
- /code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies
1010
- /code-security/dependabot/troubleshooting-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies
11+
- /code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-the-detection-of-vulnerable-dependencies
1112
versions:
1213
fpt: '*'
1314
ghes: '*'
@@ -22,12 +23,12 @@ topics:
2223
- Vulnerabilities
2324
- CVEs
2425
- Repositories
25-
contentType: how-tos
26+
contentType: reference
2627
---
2728

2829
{% data reusables.dependabot.result-discrepancy %}
2930

30-
## Why do some dependencies seem to be missing?
31+
## Missing or undetected dependencies
3132

3233
{% data variables.product.prodname_dotcom %} generates and displays dependency data differently than other tools. Consequently, if you've been using another tool to identify dependencies you will almost certainly see different results. Consider the following:
3334

@@ -38,39 +39,39 @@ contentType: how-tos
3839

3940
{% data variables.product.prodname_dependabot %} doesn't scan repositories on a schedule, but rather when something changes. For example, a scan is triggered when a new dependency is added ({% data variables.product.prodname_dotcom %} checks for this on every push), or when a new advisory is added to the database{% ifversion ghes %} and synchronized to {% data variables.product.prodname_dotcom %}{% endif %}. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts#detection-of-insecure-dependencies).
4041

41-
## Do {% data variables.product.prodname_dependabot_alerts %} only relate to insecure dependencies in manifests and lockfiles?
42+
## Alert coverage scope
4243

4344
{% data variables.product.prodname_dependabot_alerts %} advise you about dependencies you should update, including transitive dependencies, where the version can be determined from a manifest or a lockfile. {% data variables.product.prodname_dependabot_security_updates %} only suggest a change where {% data variables.product.prodname_dependabot %} can directly "fix" the dependency, that is, when these are:
4445
* Direct dependencies explicitly declared in a manifest or lockfile
4546
* Transitive dependencies declared in a lockfile
4647

4748
**Check:** Is the uncaught vulnerability for a component that's not specified in the repository's manifest or lockfile?
4849

49-
## Why don't I get {% data variables.product.prodname_dependabot_alerts %} for some ecosystems?
50+
## Unsupported ecosystems
5051

5152
{% data variables.product.prodname_dependabot_alerts %} are supported for a set of ecosystems where we can provide high-quality, actionable data. Curated advisories in the {% data variables.product.prodname_advisory_database %}, the dependency graph, {% ifversion fpt or ghec %}{% data variables.product.prodname_dependabot %} security updates, {% endif %}and {% data variables.product.prodname_dependabot_alerts %} are provided for several ecosystems, including Java’s Maven, JavaScript’s npm and Yarn, .NET’s NuGet, Python’s pip, Ruby's RubyGems, and PHP’s Composer. For an overview of the package ecosystems that we support for {% data variables.product.prodname_dependabot_alerts %}, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/dependency-graph-supported-package-ecosystems#supported-package-ecosystems).
5253

5354
It's worth noting that security advisories may exist for other ecosystems. The information in an unreviewed security advisory is provided by the maintainers of a particular repository. This data is not curated by {% data variables.product.prodname_dotcom %}. {% data reusables.security-advisory.link-browsing-advisory-db %}
5455

5556
**Check:** Does the uncaught vulnerability apply to an unsupported ecosystem?
5657

57-
## Does {% data variables.product.prodname_dependabot %} generate alerts for vulnerabilities that have been known for many years?
58+
## Historical vulnerabilities
5859

5960
The {% data variables.product.prodname_advisory_database %} was launched in November 2019, and initially back-filled to include advisories for security risks in the supported ecosystems, starting from 2017. When adding CVEs to the database, we prioritize curating newer CVEs, and CVEs affecting newer versions of software.
6061

6162
Some information on older vulnerabilities is available, especially where these CVEs are particularly widespread, however some old vulnerabilities are not included in the {% data variables.product.prodname_advisory_database %}. If there's a specific old vulnerability that you need to be included in the database, contact {% data variables.contact.contact_support %}.
6263

6364
**Check:** Does the uncaught vulnerability have a publish date earlier than 2017 in the National Vulnerability Database?
6465

65-
## Why does {% data variables.product.prodname_advisory_database %} use a subset of published vulnerability data?
66+
## Advisory database scope
6667

6768
Some third-party tools use uncurated CVE data that isn't checked or filtered by a human. This means that CVEs with tagging or severity errors, or other quality issues, will cause more frequent, more noisy, and less useful alerts.
6869

6970
Since {% data variables.product.prodname_dependabot %} uses curated data in the {% data variables.product.prodname_advisory_database %}, the volume of alerts may be lower, but the alerts you do receive will be accurate and relevant.
7071

7172
{% ifversion fpt or ghec %}
7273

73-
## Does each insecure dependency generate a separate alert?
74+
## Alert generation and aggregation
7475

7576
When a dependency has multiple vulnerabilities, an alert is generated for each vulnerability at the level of advisory plus manifest.
7677

@@ -85,11 +86,11 @@ The {% data variables.product.prodname_dependabot_alerts %} count in {% data var
8586
**Check:** If there is a discrepancy in the totals you are seeing, check that you are not comparing alert numbers with dependency numbers. Also check that you are viewing all alerts and not a subset of filtered alerts.
8687
{% endif %}
8788

88-
## Can Dependabot ignore specific dependencies?
89+
## Dependency ignore options
8990

9091
You can configure {% data variables.product.prodname_dependabot %} to ignore specific dependencies in the configuration file, which will prevent security and version updates for those dependencies. If you only wish to use security updates, you will need to override the default behavior with a configuration file. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates#overriding-the-default-behavior-with-a-configuration-file) to prevent version updates from being activated. For information about ignoring dependencies, see [Ignoring specific dependencies](/code-security/dependabot/dependabot-version-updates/controlling-dependencies-updated#ignoring-specific-dependencies).
9192

92-
## Why does {% data variables.product.prodname_dependabot %} sometimes fail to detect or update {% data variables.product.prodname_actions %} versions in monorepos?
93+
## Monorepo limitations for {% data variables.product.prodname_actions %} versions
9394

9495
If your repository contains multiple {% data variables.product.prodname_actions %} (for example, in a monorepo), the tag format you use affects how {% data variables.product.prodname_dependabot %} detects and updates action versions.
9596

data/learning-tracks/code-security.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ dependabot_alerts:
5454
- >-
5555
/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/managing-pull-requests-for-dependency-updates
5656
- >-
57-
/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-the-detection-of-vulnerable-dependencies
57+
/code-security/reference/supply-chain-security/troubleshoot-dependabot/vulnerable-dependency-detection
5858
- >-
59-
/code-security/reference/supply-chain-security/dependabot-errors
59+
/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependabot-errors
6060
dependabot_security_updates:
6161
title: Get pull requests to update your vulnerable dependencies
6262
description: >-
@@ -74,7 +74,7 @@ dependabot_security_updates:
7474
- >-
7575
/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/managing-pull-requests-for-dependency-updates
7676
- >-
77-
/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-the-detection-of-vulnerable-dependencies
77+
/code-security/reference/supply-chain-security/troubleshoot-dependabot/vulnerable-dependency-detection
7878
dependency_version_updates:
7979
title: Keep your dependencies up-to-date
8080
description: >-
@@ -104,7 +104,7 @@ dependency_version_updates:
104104
- >-
105105
/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/managing-pull-requests-for-dependency-updates
106106
- >-
107-
/code-security/reference/supply-chain-security/dependabot-errors
107+
/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependabot-errors
108108
secret_scanning:
109109
title: Scan for secrets
110110
description: >-

0 commit comments

Comments
 (0)