Skip to content

Commit d9da529

Browse files
authored
docs: clarify Sonatype Guide OSS Index suggestions (#8477)
2 parents f03b7dc + 0252f49 commit d9da529

2 files changed

Lines changed: 24 additions & 11 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,19 @@ The NVD API has enforced rate limits. If you are using a single API KEY and
4646
multiple builds occur you could hit the rate limit and receive 403 errors. In
4747
a CI environment one must use a caching strategy.
4848

49-
### Sonatype OSS Index API Token Now Required for usage
49+
### Sonatype OSS Index mandatory authentication and migration to Sonatype Guide
5050

51-
Since September 2025 Sonatype OSS Index started enforcing use of API tokens for authentication. In April 2026 a
52-
subsequent migration to Sonatype Guide began.
51+
In September 2025 Sonatype OSS Index started enforcing use of API tokens for authentication. In April 2026 a
52+
subsequent migration to Sonatype Guide began, kicking off a transition to use of Sonatype Guide API Tokens that are
53+
planned to replace the legacy OSS Index API keys/tokens before the end of 2026.
5354

54-
If you wish to use Sonatype OSS Index you must configure Dependency-Check and consider implications for migration to
55-
Sonatype Guide. See the [analyzer documentation](https://dependency-check.github.io/DependencyCheck/analyzers/oss-index-analyzer.html)
56-
for more information.
55+
Without credentials, Dependency Check will **automatically disable the OSS Index analyzer**. Please see the documentation
56+
for the CLI, Maven, Gradle, or Ant integrations on how to set the analyzer credentials for use of a Sonatype Guide token
57+
or legacy OSS Index API key.
5758

58-
Without credentials, Dependency Check will **automatically disable the OSS Index analyzer**. Please see the documentation
59-
for the cli, maven, gradle, or ant integrations on how to set the OSS Index credentials.
59+
If you wish to use Sonatype OSS Index (via Guide) you must configure Dependency-Check and consider implications for the
60+
migration to Sonatype Guide; whose commercial/usage model has changed. See the [analyzer documentation](https://dependency-check.github.io/DependencyCheck/analyzers/oss-index-analyzer.html)
61+
for more information.
6062

6163
### Gradle build Environment
6264

src/site/markdown/analyzers/oss-index-analyzer.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,8 @@ During this migration users will need to make some minor changes.
2222
- login with OSS Index account credentials to the Sonatype Guide platform to validate your account has been migrated
2323
- migrate OSS Index analyzer base URL to Sonatype Guide platform
2424
- override Dependency-Check configuration OR
25-
- upgrade to Dependency-Check `12.2.1`+ (if using defaults)
26-
- review API usage within Sonatype Guide to determine whether continued free usage is possible (new API limits apply from April 28 2026 onwards)
27-
- consider [cache/restore of Dependency-Check's data directory](../data/cacheh2.md) between runs to retain the OSS Index cache, and reduce API load
25+
- upgrade to Dependency-Check `12.2.2`+ (if using defaults)
26+
- review API usage within Sonatype Guide to determine whether continued free usage is possible (new API limits apply from April 28, 2026 onwards)
2827
- _Before_ December 31, 2026
2928
- migrate to using a Sonatype Guide API token for authentication rather than the legacy OSS Index API token
3029
- For **new** users
@@ -35,3 +34,15 @@ For more details on this migration see:
3534
- [Sonatype OSS Index product page](https://www.sonatype.com/products/sonatype-guide/oss-index-users)
3635
- [Sonatype Migration timeline](https://help.sonatype.com/en/oss-index-migration-to-sonatype-guide.html)
3736
- [Using Sonatype Guide personal access tokens for OSS Index API](https://help.sonatype.com/en/using-guide-personal-access-tokens-with-oss-index-api-integrations.html)
37+
38+
### Managing Sonatype Guide credit usage
39+
40+
In contrast to the earlier completely free OSS Index solution, Sonatype Guide gives a limited number of credits on free
41+
accounts; and effectively charges per component report. You can review your credit usage in your Sonatype Guide account.
42+
43+
To reduce your credit usage:
44+
- consider [cache/restore of Dependency-Check's data directory](../data/cacheh2.md) between runs to retain the OSS Index cache, and reduce API load
45+
- consider retaining OSS Index cache entries longer by extending the analyzer's `validForHours` configuration setting beyond the 24-hour default
46+
- extending cache time, will reduce credit usage at the cost of slower notification about potential new vulnerabilities
47+
- consider reducing frequency of running OSS Index analysis on builds
48+
- for example, you may want to disable OSS Index analysis on local dev or per-commit/merge CI builds, and enable only for a daily or weekly scheduled build

0 commit comments

Comments
 (0)