README

与 CycloneDX 文档一起工作。
OWASP CycloneDX 是一种全栈物料清单 (BOM) 标准，它提供了降低网络风险的先进供应链功能。

责任

• 提供 CycloneDX 的一般目的 php 实现。
• 为该实现提供 phpDoc3 和 psalm 兼容的注释，以便开发人员和开发工具可以依赖它。
• 提供与 CycloneDX 一起工作的数据模型。
• 提供 JSON 和 XML 规范化程序，...
  • 支持所有已发布的数据模型。
  • 尊重任何注入的 CycloneDX 规范 并根据它生成有效输出。
  • 可以为 JSON 和 XML 序列化准备数据结构。
• 序列化
  • 提供 JSON 序列化器。
  • 提供 XML 序列化器。
• 针对 CycloneDX 规范进行验证
  • 提供 JSON 验证器。
  • 提供 XML 验证器。
• 提供基于 composer 的自动加载，以便进行下游使用。

功能

• 以下用例的枚举
  • ComponentType
  • ExternalReferenceType
  • HashAlgorithm
  • LicenseAcknowledgement
• 以下用例的数据模型
  • Bom
  • BomRef, BomRefRepository
  • Component, ComponentRepository, ComponentEvidence
  • ExternalReference, ExternalReferenceRepository
  • HashDictionary
  • LicenseExpression, NamedLicense, SpdxLicense, LicenseRepository
  • 元数据
  • Property, PropertyRepository
  • Tool, ToolRepository
• 以下用例的实用工具
  • 为 Bom.serialNumber 生成有效的随机序列号
• 以下用例的工厂
  • 从任何许可证描述符字符串创建数据模型
• 以下版本的 CycloneDX 规范 实现
  • 1.6
  • 1.5
  • 1.4
  • 1.3
  • 1.2
  • 1.1
• 将数据模型转换为 JSON 结构的规范化程序
• 将数据模型转换为 XML 结构的规范化程序
• 将 Bom 数据模型转换为 JSON 字符串的序列化程序
• 将 Bom 数据模型转换为 XML 字符串的序列化程序
• 检查 JSON 是否符合 CycloneDX 规范的验证器
• 检查 XML 是否符合 CycloneDX 规范的验证器

安装

通过 composer 安装

composer require cyclonedx/cyclonedx-library

用法

请参阅扩展的 示例。

$bom = new \CycloneDX\Core\Models\Bom();
$bom->getComponents()->addItems(
    new \CycloneDX\Core\Models\Component(
        \CycloneDX\Core\Enums\ComponentType::Library,
        'myComponent'
    )
);

API 文档

我们提供代码注释，以便您的 IDE 和工具可以在您使用此库时捕获文档。

还有在 readthedocs 上托管的预渲染文档。

此外，还有一个为 phpDoc3 准备的配置，您可以使用它来生成自己的文档。

冲突

由于该库是从 /src/Core (346e6200fb2f5086061b15c2ee44f540893ce97d) of cyclonedx-php-composer 中分离出来的，因此它会与原始源代码冲突：cyclonedx/cyclonedx-php-composer:<3.5。

贡献

请随时打开问题报告、错误报告或拉取请求。
有关详细信息，请参阅 CONTRIBUTING 文件。

许可证

在Apache 2.0许可证的条款下，允许修改和重新分发。
有关完整许可证，请参阅 LICENSE 文件。