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)¶

（实验性）生成 Cyclone 1.4 JSON 格式的 SBOM

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

参数: conanfile: conanfile 实例。 name (str, 可选): 元数据字段的自定义名称。 add_build (bool, 可选, default=False): 包含构建依赖项。 add_tests (bool, 可选, default=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)¶

（实验性）生成 Cyclone 1.6 JSON 格式的 SBOM

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

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

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

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

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

另请参阅