旋风DX JavaScript 库

西非办事处 旋风DX 是一个完整的材料清单和系统透明度标准 提供软件、服务、硬件和AI组件的能见度,使高级供应链安全和网络风险降低成为可能.

此软件包提供了 旋风DX 页:1 Java 脚本 (单位:千美元)节点.js 或者说 网页浏览器, (中文(简体) ), 写入 类型脚本 并编集为目标.

[注]
这个软件包是一个软件库,不准备单独使用.
用于生成软件手册(SBOM)的工具和插件列表,请检查 元包装。 。 。 .

责任

• 提供一般目的 Java 脚本- 实施 旋风DX 页:1 节点.js 财务报告和审定财务报表 网页浏览器。 。 。 .
• 为所述执行提供打字,这样开发者和dev-tool就可以依赖.
• 提供数据模型与 旋风DX。 。 。 .
• 提供JSON和XML正常剂,即...
  • 支持所有已运出的数据模型.
  • 尊重任何注入 旋风DX 规格 并据此生成有效的输出.
  • 可配置以生成可再生产/决定性输出.
  • 可以为JSON-和XML-序列化准备数据结构.
• 序列化 :
  • 为所有目标环境提供通用的JSON序列器.
  • 为所有目标环境提供 XML 序列器 .
  • 支持在下游实施适合特定环境的自定义XML序列器
    提供抽象的基础课,照顾到正常化和BomRef歧视.
    这样做是因为没有通用的 XML 支持 Java 脚本。 。 。 .
• 根据 旋风DX 规格. (目前为 节点.js 仅限)

能力

• 下列用例的用量:
  • AttachmentEncoding
  • ComponentScope
  • ComponentType
  • ExternalReferenceType
  • HashAlgorithm
  • Vulnerability 有关:
    • AffectStatus
    • AnalysisJustification
    • AnalysisResponse
    • AnalysisState
    • RatingMethod
    • Severity
• 下列使用案例的数据模型:
  • Attachment
  • Bom
  • BomLink, (中文(简体) ), BomLinkDocument, (中文(简体) ), BomLinkElement
  • BomRef, (中文(简体) ), BomRefRepository
  • Component, (中文(简体) ), ComponentRepository, (中文(简体) ), ComponentEvidence
  • ExternalReference, (中文(简体) ), ExternalReferenceRepository
  • Hash, (中文(简体) ), HashContent, (中文(简体) ), HashDictionary
  • LicenseExpression, (中文(简体) ), NamedLicense, (中文(简体) ), SpdxLicense, (中文(简体) ), LicenseRepository
  • Metadata
  • OrganizationalContact, (中文(简体) ), OrganizationalContactRepository
  • OrganizationalEntity, (中文(简体) ), OrganizationalEntityRepository
  • Property, (中文(简体) ), PropertyRepository
  • SWID
  • Tool, (中文(简体) ), ToolRepository, (中文(简体) ), Tools
  • Vulnerability 有关:
    • Advisory, (中文(简体) ), AdvisoryRepository
    • Affect, (中文(简体) ), AffectRepository, (中文(简体) ), AffectedSingleVersion, (中文(简体) ), AffectedVersionRange, (中文(简体) ), AffectedVersionRepository
    • Analysis
    • Credits
    • Rating, (中文(简体) ), RatingRepository
    • Reference, (中文(简体) ), ReferenceRepository
    • Source
    • Vulnerability, (中文(简体) ), VulnerabilityRepository
• 下列用途的水电费:
  • 生成有效的随机序列号 Bom.serialNumber
  • 从文件中收集许可证证据(用于: 节点.js 仅限)
• 下列使用的工厂:
  • 从任何许可描述字符串创建数据模型
  • 具体针对 节点.js: 从类似Json的数据结构和衍生数据创建数据模型
• 用于下列用途的构建器:
  • 具体针对 节点.js: 创建深层数据模型 Tool 或者说 Component 从类似Json软件包的数据结构
• 执行《公约》 旋风DX 规格 用于下列版本:
  • 1.7
  • 1.6
  • 1.5
  • 1.4
  • 1.3
  • 1.2
• 将数据模型转换为 JSON 结构的常态化器
• 将数据模型转换为 XML 结构的常态器
• 转换的通用序列器 Bom 数据模型到 JSON 字符串
• 转换特定序列器 Bom xML 字符串的数据模型 :
  • 具体针对 网页浏览器: 执行时使用特定浏览器的文档生成器和打印机.
  • 具体针对 节点.js执行:利用 可选依赖关系 说明如下:
• JSON 字符串和 XML 字符串的正式验证器( 目前用于 节点.js 仅限)
  要求数 可选依赖关系 说明如下:

安装

该软件包和构建结果可供 无, (中文(简体) ), 小时 财务报告和审定财务报表 线条数字 :

npm i -S @cyclonedx/cyclonedx-library
pnpm add @cyclonedx/cyclonedx-library
yarn add @cyclonedx/cyclonedx-library

你可以从源头安装软件包, 将自动在安装的基础上建立:

npm i -S github:CycloneDX/cyclonedx-javascript-library
pnpm add github:CycloneDX/cyclonedx-javascript-library
yarn add @cyclonedx/cyclonedx-library@github:CycloneDX/cyclonedx-javascript-library # only with yarn-2

可选同伴依赖关系

一些特性需要可选的对等依赖性——见 package.json 用于版本细节.

• 串行到 XML 上 节点.js 要求:
  • xmlbuilder2
• JSON 的验证 节点.js 要求所有:
  • ajv
  • ajv-formats
  • ajv-formats-draft2019
• XML 上的验证 节点.js 要求:
  • libxmljs2
    • 系统可能需要满足 node-gyp,在某些情况下.

此外,我们还就相关的第三方标准提出了一些建议:

• packageurl-js 用于制作和解析软件包URL.
• spdx-expression-parse 用于验证 SPDX 许可证表达式.

使用量

参见扩展 实例。 。 。 .

作为 节点.js 软件包

const CDX = require('@cyclonedx/cyclonedx-library')

const bom = new CDX.Models.Bom()
bom.metadata.component = new CDX.Models.Component(
  CDX.Enums.ComponentType.Application,
  'MyProject'
)
const componentA = new CDX.Models.Component(
  CDX.Enums.ComponentType.Library,
  'myComponentA',
)
bom.components.add(componentA)
bom.metadata.component.dependencies.add(componentA.bomRef)

确保最佳 树起摇动 何时 捆绑,只导入您实际需要的符号 切入点。 您可以在 exports 软件包字段 package.json。 。 。 .

const { Bom, Component } = require('@cyclonedx/cyclonedx-library/Models')
const { ComponentType } = require('@cyclonedx/cyclonedx-library/Enums')

const bom = new Bom()
bom.metadata.component = new Component(
  ComponentType.Application,
  'MyProject'
)
const componentA = new Component(
  ComponentType.Library,
  'myComponentA',
)
bom.components.add(componentA)
bom.metadata.component.dependencies.add(componentA.bomRef)

单位 网页浏览器

<script src="path-to-this-package/dist.web/lib.js"></script>
<script type="application/javascript">
    const CDX = CycloneDX_library

    let bom = new CDX.Models.Bom()
    bom.metadata.component = new CDX.Models.Component(
        CDX.Enums.ComponentType.Application,
        'MyProject'
    )
    const componentA = new CDX.Models.Component(
        CDX.Enums.ComponentType.Library,
        'myComponentA',
    )
    bom.components.add(componentA)
    bom.metadata.component.dependencies.add(componentA.bomRef)
</script>

API 文档

我们发送附加说明的类型定义, 这样你的 IDE 和工具可以拿起文档 当你使用这个库下游.

另有在下列网站上寄存的文件: 读取文档。 。 。 .

发展和贡献

随意打开问题,错误报告或调取请求.
见 捐款 详细文件.

许可证

根据Apache 2.0许可证的规定,允许修改和再分配.
见 自由主义 完整许可证存档.