Skip to content

PEP 503-normalize PyPI package names for vuln matching - #7546

Merged
nscuro merged 1 commit into
DependencyTrack:mainfrom
nscuro:pep503-normalize
Oct 3, 2026
Merged

nscuro merged 1 commit into
DependencyTrack:mainfrom
nscuro:pep503-normalize

Conversation

@nscuro

@nscuro nscuro commented Oct 3, 2026

Copy link
Copy Markdown
Member

Description

PEP 503-normalizes PyPI package names for vuln matching.

Addressed Issue

N/A

Additional Details

According to PEP 503:

The name should be lowercased with all runs of the characters
., -, or _ replaced with a single - character.

Meaning chartkit-core and e.g. chartkit._Core should be treated equal. This requires normalization that Dependency-Track did not do, which led to false negatives when imported BOM data did not arrive already-normalized, since OSV does normalize package names.

For example, https://osv.dev/vulnerability/MAL-2026-15932 is filed against pkg:pypi/chartkit-core, but a BOM could include pkg:pypi/Chartkit.Core and consequently wouldn't match.

Thanks to Ilyas Makari of Aikido Security for reporting this issue.

Checklist

  • I have read and understand the contributing guidelines
  • This PR fixes a defect, and I have provided tests to verify that the fix is effective
  • This PR implements an enhancement, and I have provided tests to verify that it works as intended
  • This PR introduces changes to the database model, and I have updated the migration changelog accordingly
  • This PR introduces new or alters existing behavior, and I have updated the documentation accordingly
  • This PR is a substantial change (per the ADR criteria), and I have added an ADR under docs/adr/

According to PEP 503:

> The name should be lowercased with all runs of the characters
> `.`, `-`, or `_` replaced with a single `-` character.

Meaning `chartkit-core` and e.g. `chartkit._Core` should be treated equal. This requires normalization that Dependency-Track did not do, which led to false negatives when imported BOM data did not arrive already-normalized, since OSV *does* normalize package names.

For example, https://osv.dev/vulnerability/MAL-2026-15932 is filed against `pkg:pypi/chartkit-core`, but a BOM could include `pkg:pypi/Chartkit.Core` and consequently wouldn't match.

Thanks to Ilyas Makari of Aikido Security for reporting this issue.

Signed-off-by: nscuro <nscuro@protonmail.com>
@nscuro nscuro added this to the 5.2 milestone Oct 3, 2026
@nscuro nscuro added defect Something isn't working backport/5.1.2 labels Oct 3, 2026
@codacy-production

codacy-production Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity

Metric Results
Complexity 0

View in Codacy

🟢 Coverage 100.00% diff coverage · -0.02% coverage variation

Metric Results
Coverage variation ✅ -0.02% coverage variation (-1.00%)
Diff coverage ✅ 100.00% diff coverage (70.00%)

View coverage diff in Codacy

Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (fae4695) 45798 40205 87.79%
Head commit (24036ba) 45807 (+9) 40204 (-1) 87.77% (-0.02%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#7546) 13 13 100.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@nscuro
nscuro merged commit a2f0b5e into DependencyTrack:main Oct 3, 2026
21 checks passed
@nscuro
nscuro deleted the pep503-normalize branch October 3, 2026 16:21
nscuro added a commit that referenced this pull request Oct 4, 2026
PyPI treats names that differ only in case or in runs of `.`, `-`, and `_`
as the same package. Vulnerability sources such as OSV publish normalized
names, so components whose PURLs used a different spelling, e.g.
`pkg:pypi/Chartkit.Core`, were not matched.

Normalize PyPI names when matching and when persisting vulnerable software,
and normalize existing records during upgrade.

Also bump the version to 4.14.5-SNAPSHOT for the next patch release.

Backport of #7546 (a2f0b5e).

Signed-off-by: nscuro <nscuro@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

defect Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant