conan.tools.sbom¶

CycloneDX¶

CycloneDX 工具可在 conan.tools.sbom.cyclonedx 模块中找到。

它提供了 cyclonedx_1_4 和 cyclonedx_1_6 函数，它们接收一个 conanfile 并返回一个包含 CycloneDX 1.4/1.6 JSON 格式的 SBOM 数据的字典。

cyclonedx_1_4(conanfile, name=None, add_build=False, add_tests=False, **kwargs)¶

(实验性) 生成 JSON 格式的 Cyclone 1.4 SBOM

从给定的依赖关系图中创建 CycloneDX 1.4 软件物料清单 (SBOM)。

参数: conanfile: conanfile 实例。 name (str, 可选): 元数据字段的自定义名称。 add_build (bool, 可选, 默认=False): 包含构建依赖项。 add_tests (bool, 可选, 默认=False): 包含测试依赖项。
返回: 生成的 CycloneDX 1.4 文档（字符串形式）。

示例用法: ` cyclonedx_1_4(conanfile, name="custom_name", add_build=True, add_test=True, **kwargs) `

cyclonedx_1_6(conanfile, name=None, add_build=False, add_tests=False, **kwargs)¶

(实验性) 生成 JSON 格式的 Cyclone 1.6 SBOM

从给定的依赖关系图中创建 CycloneDX 1.6 软件物料清单 (SBOM)。

参数: conanfile: conanfile 实例。 name (str, 可选): 元数据字段的自定义名称。 add_build (bool, 可选, 默认=False): 包含构建依赖项。 add_tests (bool, 可选, 默认=False): 包含测试依赖项。
返回: 生成的 CycloneDX 1.6 文档（字符串形式）。

示例用法: ` cyclonedx_1_6(conanfile, name="custom_name", add_build=True, add_test=True, **kwargs) `

这两个函数共享一个接口，并且非常相似；主要区别在于它们各自支持的 CycloneDX 版本。选项 add_build 和 add_test 允许您分别包含由依赖关系图解析的构建包和测试包。

如果您希望将它们添加到您的 SBOM 中，请记住启用相应选项！

另请参阅