警告
此功能是实验性的,可能会发生重大更改。有关更多信息,请参阅 Conan 稳定性 部分。
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, optional): 元数据字段的自定义名称。 add_build (bool, optional, default=False): 包含构建依赖项。 add_tests (bool, optional, 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)¶
(实验性) 生成 JSON 格式的 Cyclone 1.6 SBOM
从给定的依赖图创建 CycloneDX 1.6 软件物料清单 (SBOM)。
- 参数
conanfile: conanfile 实例。 name (str, optional): 元数据字段的自定义名称。 add_build (bool, optional, default=False): 包含构建依赖项。 add_tests (bool, optional, 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 中,请启用该选项!
另请参阅