CycloneDX / CycloneDX/cyclonedx-python

[BUG] Environment can produce indirect dependency cycles due to extras

クローズ
#1,102 コメント 5 件 リアクション 0 件 担当者 0 名 GitHub で見る
bug
主要言語
Python
スター
390
フォーク
98
平均マージ
2日 23時間
マージ済み PR(30日)
2

説明

## Describe the bug

When scanning the requires of a given package, cyclonedx-python appears to include a given package in `dependsOn` if that package exists in the environment even if the extra was not actually specified when installing the package. This can create indirect dependency cycles in the SBOM which tools like Sunshine do not handle well.

## To Reproduce

This is easiest to see in a package like matplotlib where it has dependencies that will have some `test` or `plot` extra that declare matplotlib as a dependency. Install matplotlib into an empty virtual environment and generate an SBOM from that environment. matplotlib will be listed as a dependency in multiple components.

## Expected behavior

The SBOM only includes includes a dependency in `dependsOn` when it's known that the dependency was requested by the component.

## Environment

- _cyclonedx-py_ version: 7.3.1
- Python version: 3.10.12
- OS: Ubuntu Linux

## Additional context

This isn't a trivial problem to solve. A virtual environment doesn't appear to expose a means of querying what extras were chosen for a given package. One could choose a heuristic like "only include the dependencies if all of the dependencies specified by that extra exist in the environment," but that heuristic fails in the MRE: matplotlib depends on fonttools which has a `plot` extra whose only requirement is matplotlib.

## Contribution

- [ ] I am willing to provide a fix
- [x] I will wait until somebody else fixes it

If I had a better understanding of the internals, I might have been able to provide a fix but the nature of this problem might require more discussion.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

Start by reproducing the matplotlib case in an empty virtual environment with cyclonedx-python 7.3.1, then trace how installed package requirements and extras become SBOM dependsOn entries. Done means the generated SBOM includes a dependency only when it is known to have been requested and does not contain the described indirect cycles.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
devtools, security
issue の種類
バグ
難易度
5/5
見積もり時間
1週間以上
活発さ
活発
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。