From 3c482fae62c379f26bb336fcd794b4cbd6e52628 Mon Sep 17 00:00:00 2001 From: Zhenyu Zheng Date: Sat, 4 Jan 2025 12:02:48 +0800 Subject: [PATCH 01/19] Add Chinese translation for models - Part V Add Chinese translation for SimpleLicensing and Software models, this is the last patch for the series. Signed-off-by: Zhenyu Zheng --- .../SimpleLicensing/Classes/AnyLicenseInfo.md | 19 ++++++++ .../Classes/LicenseExpression.md | 12 +++++ .../Classes/SimpleLicensingText.md | 8 ++++ .../Properties/customIdToUri.md | 15 +++++++ .../Properties/licenseExpression.md | 13 ++++++ .../Properties/licenseListVersion.md | 12 +++++ .../SimpleLicensing/Properties/licenseText.md | 10 +++++ model/SimpleLicensing/SimpleLicensing.md | 14 ++++++ model/Software/Classes/ContentIdentifier.md | 12 +++++ model/Software/Classes/File.md | 12 +++++ model/Software/Classes/Package.md | 21 +++++++++ model/Software/Classes/Sbom.md | 10 +++++ model/Software/Classes/Snippet.md | 10 +++++ model/Software/Classes/SoftwareArtifact.md | 10 +++++ .../Software/Properties/additionalPurpose.md | 9 ++++ model/Software/Properties/attributionText.md | 14 ++++++ model/Software/Properties/byteRange.md | 11 +++++ .../Software/Properties/contentIdentifier.md | 8 ++++ .../Properties/contentIdentifierType.md | 8 ++++ .../Properties/contentIdentifierValue.md | 8 ++++ model/Software/Properties/copyrightText.md | 20 +++++++++ model/Software/Properties/downloadLocation.md | 10 +++++ model/Software/Properties/fileKind.md | 10 +++++ model/Software/Properties/homePage.md | 12 +++++ model/Software/Properties/lineRange.md | 14 ++++++ model/Software/Properties/packageUrl.md | 20 +++++++++ model/Software/Properties/packageVersion.md | 9 ++++ model/Software/Properties/primaryPurpose.md | 8 ++++ model/Software/Properties/sbomType.md | 12 +++++ model/Software/Properties/snippetFromFile.md | 8 ++++ model/Software/Properties/sourceInfo.md | 12 +++++ model/Software/Software.md | 8 ++++ .../Vocabularies/ContentIdentifierType.md | 14 ++++++ model/Software/Vocabularies/FileKindType.md | 16 +++++++ model/Software/Vocabularies/SbomType.md | 22 ++++++++++ .../Software/Vocabularies/SoftwarePurpose.md | 44 +++++++++++++++++++ 36 files changed, 475 insertions(+) diff --git a/model/SimpleLicensing/Classes/AnyLicenseInfo.md b/model/SimpleLicensing/Classes/AnyLicenseInfo.md index db0eda25d..242501b4d 100644 --- a/model/SimpleLicensing/Classes/AnyLicenseInfo.md +++ b/model/SimpleLicensing/Classes/AnyLicenseInfo.md @@ -32,3 +32,22 @@ It can be: - name: AnyLicenseInfo - SubclassOf: /Core/Element - Instantiability: Abstract + +## Summary @zh-Hans + +表示一个或多个许可证组合的抽象类。 + +## Description @zh-Hans + +`AnyLicenseInfo`是一个抽象类，表示由一个或多个许可证（可选包括附加文本）组成的许可证组合，这些许可证可根据[SPDX许可证表达式语法](../../../annexes/spdx-license-expressions.md)进行组合。 + +`AnyLicenseInfo`可用于软件工件的许可属性。 + + +它可以是 +- `NoneLicense`； +- `NoAssertionLicense`； +- （在[SPDX许可证列表](https://spdx.org/licenses/)或[自定义许可证](../../ExpandedLicensing/Classes/CustomLicense.md)）的单一许可证； +- 应用了“or later”操作符的单一许可证； +- 应用了附加文本的上述许可证；或 +- 通过递归应用“AND”和“OR”运算符组合的许可证集。 diff --git a/model/SimpleLicensing/Classes/LicenseExpression.md b/model/SimpleLicensing/Classes/LicenseExpression.md index 7e6d18394..587f6b18d 100644 --- a/model/SimpleLicensing/Classes/LicenseExpression.md +++ b/model/SimpleLicensing/Classes/LicenseExpression.md @@ -39,3 +39,15 @@ license expression as a combination of license objects. - customIdToUri - type: /Core/DictionaryEntry - minCount: 0 + +## Summary @zh-Hans + +一个包含SPDX许可证表达式字符串的SPDX元素。 + +## Description @zh-Hans + +一个`LicenseExpression`可以在单个字符串中表示一个或多个许可证的组合，以及许可证例外情况等附加内容。 + +`licenseExpression`字符串的语法在本规范的相应附件（[“SPDX 许可证表达式”](../../../annexes/spdx-license-expressions.md)）中规定。如果一个`licenseExpression`字符串不符合该附件中规定的语法，则该字符串无效。 + +`ExpandedLicensing`配置文件可用于将完整解析的许可证表达式表示为许可证对象的组合。 diff --git a/model/SimpleLicensing/Classes/SimpleLicensingText.md b/model/SimpleLicensing/Classes/SimpleLicensingText.md index 0378f086e..d24168d27 100644 --- a/model/SimpleLicensing/Classes/SimpleLicensingText.md +++ b/model/SimpleLicensing/Classes/SimpleLicensingText.md @@ -24,3 +24,11 @@ and is therefore defined by an SPDX data creator. - type: xsd:string - minCount: 1 - maxCount: 1 + +## Summary @zh-Hans + +未在SPDX许可证列表中列出的许可证或附加内容。 + +## Description @zh-Hans + +单一许可证文本（`SimpleLicensingText`）表示SPDX许可证列表中未列出因而由SPDX数据创建者定义的许可证（`License`）或附加项（`Addition`）。 diff --git a/model/SimpleLicensing/Properties/customIdToUri.md b/model/SimpleLicensing/Properties/customIdToUri.md index a8df334a4..9cfeffe4e 100644 --- a/model/SimpleLicensing/Properties/customIdToUri.md +++ b/model/SimpleLicensing/Properties/customIdToUri.md @@ -29,3 +29,18 @@ CustomLicenseAddition, or SimpleLicensingText. - name: customIdToUri - Nature: ObjectProperty - Range: /Core/DictionaryEntry + + +## Summary @zh-Hans + +将自定义许可证或自定义许可证附加信息的`LicenseRef`或`AdditionRef`字符串映射到其URI ID上。 + +## Description @zh-Hans + +在许可证表达式中，可以引用自定义许可证或自定义许可证附加内容。 + +[License Expression syntax](https://github.com/spdx/spdx-3-model/blob/main/annexes/spdx-license-expressions.md)规定，任何以 “LicenseRef-”或 “AdditionRef-”开头的引用都是指官方[SPDX许可证列表](https://spdx.org/licenses/)中没有的许可证或附加内容。 + +这些自定义许可证必须是一个`CustomLicense`、`CustomLicenseAddition`或`SimpleLicensingText`，它们都有一个唯一的URI标识符。 + +`DictionaryEntry`的关键是许可证表达式中使用的字符串，值则是对应的`CustomLicense`、`CustomLicenseAddition`或`SimpleLicensingText`的URI。 diff --git a/model/SimpleLicensing/Properties/licenseExpression.md b/model/SimpleLicensing/Properties/licenseExpression.md index 221ece115..9670c1e38 100644 --- a/model/SimpleLicensing/Properties/licenseExpression.md +++ b/model/SimpleLicensing/Properties/licenseExpression.md @@ -26,3 +26,16 @@ license expression as a combination of license objects. - name: licenseExpression - Nature: DataProperty - Range: xsd:string + + +## Summary @zh-Hans + +许可证表达式格式的字符串。 + +## Description @zh-Hans + +许可证表达式（`licenseExpression`）可在单个字符串中表示一个或多个许可证的组合，以及许可证例外情况等附加内容。 + +许可证表达式（`licenseExpression`）字符串的语法在本规范的相应附件（["SPDX 许可证表达式”](../../../annexes/spdx-license-expressions.md)）中规定。如果一个许可证表达式（`licenseExpression`）字符串不符合该附件中规定的语法，则该字符串无效。 + +`ExpandedLicensing`配置文件可用于将完整解析的许可证表达式表示为许可证对象的组合。 diff --git a/model/SimpleLicensing/Properties/licenseListVersion.md b/model/SimpleLicensing/Properties/licenseListVersion.md index 2ce56cbf1..eacdff753 100644 --- a/model/SimpleLicensing/Properties/licenseListVersion.md +++ b/model/SimpleLicensing/Properties/licenseListVersion.md @@ -24,3 +24,15 @@ and exceptions referenced in the expression. - name: licenseListVersion - Nature: DataProperty - Range: /Core/SemVer + +## Summary @zh-Hans + +许可证表达式中使用的SPDX许可证列表版本。 + +## Description @zh-Hans + +由于[SPDX许可证列表](https://spdx.org/licenses/)会随着每个后续版本的增加而增补，因此需要向消费者提供所使用的SPDX许可证列表版本。 + +这样做的目的是为了避免将来许可表达使用的SPDX许可列表版本早于当前版本。 + +指定版本的SPDX许可证列表必须包括表达式中引用的所有列出的许可证和例外情况。 diff --git a/model/SimpleLicensing/Properties/licenseText.md b/model/SimpleLicensing/Properties/licenseText.md index a4e41a05a..2c1d75475 100644 --- a/model/SimpleLicensing/Properties/licenseText.md +++ b/model/SimpleLicensing/Properties/licenseText.md @@ -20,3 +20,13 @@ when comparing it to another text for matching purposes. - name: licenseText - Nature: DataProperty - Range: xsd:string + +## Summary @zh-Hans + +标识许可证（`License`）或附加内容（`Addition`）的全文。 + +## Description @zh-Hans + +一个许可证文本（`licenseText`）包含许可证（`License`）或附加内容（`Addition`）的纯文本，不含模板或其他类似标记。 + +许可证（`License`）的许可证文本（`licenseText`）用户在将其与其他文本进行匹配时，可应用[SPDX许可证列表匹配指南](../../../annexes/license-matching-guidelines-and-templates.md)。 diff --git a/model/SimpleLicensing/SimpleLicensing.md b/model/SimpleLicensing/SimpleLicensing.md index 9dc43ccaa..9e8883479 100644 --- a/model/SimpleLicensing/SimpleLicensing.md +++ b/model/SimpleLicensing/SimpleLicensing.md @@ -25,3 +25,17 @@ license expressions. - id: https://spdx.org/rdf/3.0.1/terms/SimpleLicensing - name: SimpleLicensing + +## Summary @zh-Hans + +与软件许可相关的附加元数据。 + +## Description @zh-Hans + +`SimpleLicensing`配置文件提供了以[许可证表达式](../../annexes/spdx-license-expressions.md)字符串来表达许可表达式的类和属性。 + +它还提供了一个基本的抽象类`AnyLicenseInfo`，用于引用许可信息。 + +`SimpleLicensingText`类为记录与[SPDX许可证列表](https://spdx.org/licenses/)上许可证不匹配的许可证文本提供了的位置。 + +`ExpandedLicensing`配置文件可用于表示完全解析的许可证表达式。 diff --git a/model/Software/Classes/ContentIdentifier.md b/model/Software/Classes/ContentIdentifier.md index 8d36ac264..982d749be 100644 --- a/model/Software/Classes/ContentIdentifier.md +++ b/model/Software/Classes/ContentIdentifier.md @@ -29,3 +29,15 @@ It can be used for verifying its identity and integrity. - type: xsd:anyURI - minCount: 1 - maxCount: 1 + + +## Summary @zh-Hans + +一个规范的、唯一的、不可变的标识符。 + +## Description @zh-Hans + +内容标识符(`ContentIdentifier`) 是软件工件内容的一个规范的、唯一的、不可变的标识符，例如一个软件包，一个文件或一个代码片段。 + +它可用于验证其身份和完整性。 + diff --git a/model/Software/Classes/File.md b/model/Software/Classes/File.md index f9643d8a5..fdb8fbde2 100644 --- a/model/Software/Classes/File.md +++ b/model/Software/Classes/File.md @@ -34,3 +34,15 @@ a directory and all content stored in that directory. - /Core/Element/name - minCount: 1 + +## Summary @zh-Hans + +指计算机上存储内容的任意对象。 + +## Description @zh-Hans + +指计算机上存储内容的任意对象。 + +内容的类型可以通过可选地contentType 属性提供。 + +fileKind 属性可以设置为directory ，用以表示文件代表的目录和该目录中的所有内容。 diff --git a/model/Software/Classes/Package.md b/model/Software/Classes/Package.md index 12f272e88..faf532fc6 100644 --- a/model/Software/Classes/Package.md +++ b/model/Software/Classes/Package.md @@ -59,3 +59,24 @@ Note that some of these could be represented in SPDX as a file as well. - /Core/Element/name - minCount: 1 + +## Summary @zh-Hans + +指的是与软件分发相关的任何内容单元。 + +## Description @zh-Hans + + 包(`Package`)指与软件分发相关的任何内容单元。 + +通常，一个软件包由一个或多个文件组成。 + +在SPDX中表达一个软件包，包含但不限于以下示例： + +* 一个tar,zip或其他压缩文件 +* 一个目录或者子目录 +* 一个被其他包或文件使用或依赖的独立分发软件(例如 一个Python包, 一个 Go 模块 ...) +* 一个容器镜像，以及/或者容器镜像里的一个镜像层 +* 一个或多个子包的集合 +* 一个特定时间点的git代码仓库快照 + +需要注意的是上述内容中的一些也可以在SPDX中被表示为文件。 diff --git a/model/Software/Classes/Sbom.md b/model/Software/Classes/Sbom.md index 60ea860fb..23136e3ef 100644 --- a/model/Software/Classes/Sbom.md +++ b/model/Software/Classes/Sbom.md @@ -25,3 +25,13 @@ information, known quality or security issues, etc. - sbomType - type: SbomType - minCount: 0 + +## Summary @zh-Hans + +用于描述一个软件包的SPDX元素集合。 + +## Description @zh-Hans + +软件物料清单(`Sbom`)是用于描述一个软件包的所有SPDX元素集合。 + +这可能包括产品内容及其组成的详细信息，产品和/或其成分的溯源信息，许可证信息，已知的质量或安全问题等。 diff --git a/model/Software/Classes/Snippet.md b/model/Software/Classes/Snippet.md index 9b17d4943..7f5760e29 100644 --- a/model/Software/Classes/Snippet.md +++ b/model/Software/Classes/Snippet.md @@ -34,3 +34,13 @@ vulnerability. - type: File - minCount: 1 - maxCount: 1 + +## Summary @zh-Hans + +代码片段用于描述文件的某一部分。 + +## Description @zh-Hans + +代码片段(`Snippet`)用于描述文件的某一部分,可以用于当文件中包含来自另一个原始来源的内容的场景。 + +代码片段有助于标明文件的某部分可最初可能是在另一个许可下创建的，或者从已知存在漏洞的地方复制而来。 diff --git a/model/Software/Classes/SoftwareArtifact.md b/model/Software/Classes/SoftwareArtifact.md index 9e8c180b7..f9d0e9979 100644 --- a/model/Software/Classes/SoftwareArtifact.md +++ b/model/Software/Classes/SoftwareArtifact.md @@ -36,3 +36,13 @@ such as a package, a file, or a snippet. - contentIdentifier - type: ContentIdentifier - minCount: 0 + +## Summary @zh-Hans + +是与软件相关的一个独立条目或单元。 + +## Description @zh-Hans + +软件工件(`SoftwareArtifact`)是与软件相关的一个独立条目或单元。 + +比如，一个软件包、文件或一个代码片段。 diff --git a/model/Software/Properties/additionalPurpose.md b/model/Software/Properties/additionalPurpose.md index 3e6e94431..f29242c8a 100644 --- a/model/Software/Properties/additionalPurpose.md +++ b/model/Software/Properties/additionalPurpose.md @@ -16,3 +16,12 @@ software artifact in addition to the primaryPurpose. - name: additionalPurpose - Nature: ObjectProperty - Range: SoftwarePurpose + +## Summary @zh-Hans + +提供软件工件的附加目的信息 + +## Description @zh-Hans + +附加目的（`additionalPurpose`）提供了关于软件工件除了主要目的（`primaryPurpose`）之外的额外目的信息。 + diff --git a/model/Software/Properties/attributionText.md b/model/Software/Properties/attributionText.md index 45161e311..1050f5795 100644 --- a/model/Software/Properties/attributionText.md +++ b/model/Software/Properties/attributionText.md @@ -31,3 +31,17 @@ corresponding license. - name: attributionText - Nature: DataProperty - Range: xsd:string + +## Summary @zh-Hans + +为SPDX数据创建者提供了一个记录软件包、文件或代码片段的署名文本的地方。 + +## Description @zh-Hans + +署名文本（`attributionText`）为软件包、文件或代码片段提供了一个让消费者了解SPDX数据的署名内容的地方，以帮助软件包、文件或代码片段的再分发者复制这些署名。 + +例如，这个字段可能包含特定许可证要求在最终用户文档、广告材料或其他形式中复制的声明。 + +这个字段可能描述了署名需要在何处或在哪些情境下被复制，但这不是必需的。SPDX数据创建者也可以在其他地方（例如，在注释字段中）解释他们打算如何使用这个字段中的数据。 + +署名文本不意味着包括软件包、文件或代码片段的实际完整许可证文本。使用`hasConcludedLicense`来标识相应的许可证。 diff --git a/model/Software/Properties/byteRange.md b/model/Software/Properties/byteRange.md index 17330a826..e8ad3a8b5 100644 --- a/model/Software/Properties/byteRange.md +++ b/model/Software/Properties/byteRange.md @@ -22,3 +22,14 @@ vocabulary. - name: byteRange - Nature: DataProperty - Range: /Core/PositiveIntegerRange + +## Summary @zh-Hans + +定义了原始宿主文件中代码片段信息所适用的字节范围。 + +## Description @zh-Hans + +该字段定义了原始宿主文件中代码片段信息所适用的字节范围。 + +字节范围与各种格式化问题无关，是引用差异最准确的方式。选择从1开始编号字节范围是为了与W3C指针方法词汇表保持一致。 + diff --git a/model/Software/Properties/contentIdentifier.md b/model/Software/Properties/contentIdentifier.md index 1ac697656..05e6b4be0 100644 --- a/model/Software/Properties/contentIdentifier.md +++ b/model/Software/Properties/contentIdentifier.md @@ -19,3 +19,11 @@ It may be used for verifying its identity and/or integrity. - name: contentIdentifier - Nature: DataProperty - Range: ContentIdentifier + +## Summary @zh-Hans + +一个规范的、唯一的、不可变的工件内容标识符，可用于验证其身份和/或完整性。 + +## Description @zh-Hans + +内容标识符（`contentIdentifier`）是软件工件（如软件包、文件或代码片段）内容的一个规范的、唯一的、不可变的标识符。它可用于验证工件的身份和/或完整性。 diff --git a/model/Software/Properties/contentIdentifierType.md b/model/Software/Properties/contentIdentifierType.md index b2a9b2b6a..a01928d86 100644 --- a/model/Software/Properties/contentIdentifierType.md +++ b/model/Software/Properties/contentIdentifierType.md @@ -15,3 +15,11 @@ A contentIdentifierType specifies the type of the content identifier. - name: contentIdentifierType - Nature: ObjectProperty - Range: ContentIdentifierType + +## Summary @zh-Hans + +指定内容标识符（`contentIdentifier`）的类型。 + +## Description @zh-Hans + +内容标识符类型（`contentIdentifierType`）指定了内容标识符的类型。 diff --git a/model/Software/Properties/contentIdentifierValue.md b/model/Software/Properties/contentIdentifierValue.md index 0bad661b4..84b8b5e69 100644 --- a/model/Software/Properties/contentIdentifierValue.md +++ b/model/Software/Properties/contentIdentifierValue.md @@ -15,3 +15,11 @@ A contentIdentifierValue specifies the value of a content identifier. - name: contentIdentifierValue - Nature: DataProperty - Range: xsd:anyURI + +## Summary @zh-Hans + +用于指定内容标识符（`content identifier`）的值。 + +## Description @zh-Hans + + 内容标识符值（`contentIdentifierValue`）用于指定内容标识符的值。 diff --git a/model/Software/Properties/copyrightText.md b/model/Software/Properties/copyrightText.md index 56ed33822..632836cc4 100644 --- a/model/Software/Properties/copyrightText.md +++ b/model/Software/Properties/copyrightText.md @@ -38,3 +38,23 @@ value as described above. - name: copyrightText - Nature: DataProperty - Range: xsd:string + +## Summary @zh-Hans + +标识软件包、文件或代码片段的一个或多个版权声明的文本（如果有的话）。 + +## Description @zh-Hans + +版权文本（ `copyrightText`）由软件包、文件或代码片段中找到的一个或多个版权声明的文本组成（如果有的话）。如果版权文本包含文本，则可能包含与该软件包、文件或代码片段的一个或多个版权声明相关的任何文本（即使不完整）。 + +如果版权文本的值为“NONE”，则表示该软件包、文件或代码片段根本不包含任何版权声明。 + +如果版权文本的值为“NOASSERTION”，则表示以下情况之一适用： + +* SPDX数据创建者已尝试但无法达到合理的客观判断； + +* SPDX数据创建者没有尝试确定此字段； + +* SPDX数据创建者故意没有提供信息（这样做不应推断任何含义）。 + +如果版权文本存在，但仅由空字符串或没有实质内容的字符串组成（例如，只包含空格的字符串），那么这应该被解释为等同于上述“NOASSERTION”值。 diff --git a/model/Software/Properties/downloadLocation.md b/model/Software/Properties/downloadLocation.md index dfddf8678..b69ee511a 100644 --- a/model/Software/Properties/downloadLocation.md +++ b/model/Software/Properties/downloadLocation.md @@ -20,3 +20,13 @@ is critical for verification and tracking data. - name: downloadLocation - Nature: DataProperty - Range: xsd:anyURI + +## Summary @zh-Hans + +标识了在文档创建时软件包的下载统一资源标识符（Uniform Resource Identifier，URI）。 + +## Description @zh-Hans + +下载位置（`downloadLocation`）‌ 标识了文档创建时软件包的下载统一资源标识符（URI）。 + +下载被引用的具体软件包的位置和方式对于验证和跟踪数据至关重要。 diff --git a/model/Software/Properties/fileKind.md b/model/Software/Properties/fileKind.md index 7baa018da..b191ebb97 100644 --- a/model/Software/Properties/fileKind.md +++ b/model/Software/Properties/fileKind.md @@ -17,3 +17,13 @@ In the future, this may be extended to other kinds (e.g. network based files). - name: fileKind - Nature: ObjectProperty - Range: FileKindType + +## Summary @zh-Hans + +描述给定的文件是一个目录类型还是非目录类型的文件。 + +## Description @zh-Hans + +一个SPDX文件可能代表一个特定的文件或者一个文件目录。 + +将来，这可能会扩展到其他类型（例如，基于网络的文件）。 diff --git a/model/Software/Properties/homePage.md b/model/Software/Properties/homePage.md index c3d939c8b..8f669645e 100644 --- a/model/Software/Properties/homePage.md +++ b/model/Software/Properties/homePage.md @@ -24,3 +24,15 @@ referenced by the SPDX document creator. - name: homePage - Nature: DataProperty - Range: xsd:anyURI + +## Summary @zh-Hans + +为SPDX文档创建者提供了一个记录软件包主页网站的地方。 + +## Description @zh-Hans + +主页(`homePage`)是SPDX文档创建者记录软件包主页网站的地方。 + +这为寻找更多信息的SPDX文档接收者避免了需要搜索和验证软件包与相关项目主页之间匹配的麻烦。 + +这个链接也可以用来引用SPDX文档创建者提到的有关软件包的更多信息。 diff --git a/model/Software/Properties/lineRange.md b/model/Software/Properties/lineRange.md index f74daa9d9..28ef314ed 100644 --- a/model/Software/Properties/lineRange.md +++ b/model/Software/Properties/lineRange.md @@ -25,3 +25,17 @@ with the W3C pointer method vocabulary. - name: lineRange - Nature: DataProperty - Range: /Core/PositiveIntegerRange + +## Summary @zh-Hans + +定义了原始宿主文件中代码片段信息所适用的行范围。 + +## Description @zh-Hans + +该字段定义了原始宿主文件中代码片段信息所适用的行范围。 + +如果字节范围(`byteRange`)和行范围(`lineRange`)之间存在不一致，将以字节范围值为准。 + +行范围对于那些有已知行分隔符的文件是一个方便的引用。 + +选择从1开始对行进行编号是为了与W3C指针方法词汇表保持一致。 diff --git a/model/Software/Properties/packageUrl.md b/model/Software/Properties/packageUrl.md index defe1652f..7bee2691f 100644 --- a/model/Software/Properties/packageUrl.md +++ b/model/Software/Properties/packageUrl.md @@ -34,3 +34,23 @@ significant on the left to the least significant components on the right. - name: packageUrl - Nature: DataProperty - Range: xsd:anyURI + +## Summary @zh-Hans + +为SPDX数据创建者提供了一个记录软件包的包URL字符串（按照包URL规范）的地方。 + +## Description @zh-Hans + +包URL(`packageUrl`)（通常发音并被称为“purl”）是试图标准化包表示的方法，以便可靠地识别和定位软件包。 + +包URL是一个URL字符串，它以一种大致通用和统一的方式跨编程语言、包管理器、打包约定、工具、API和数据库来表示一个软件包。 + +包URL由七个组成部分构成： + +```plain +scheme:type/namespace/name@version?qualifiers#subpath +``` + +每个组件的定义可以在本规范的相应附录([Annex](https://../../../annexes/pkg-url-specification.md))中找到。已知类型的类型定义([type definitions](https://github.com/package-url/purl-spec/blob/b33dda1cf4515efa8eabbbe8e9b140950805f845/PURL-TYPES.rst).)可以在包URL类型定义中找到。 + +组件的设计方式是，它们从最左边的最重要的组件到最右边的最不重要的组件形成一个层次结构。 diff --git a/model/Software/Properties/packageVersion.md b/model/Software/Properties/packageVersion.md index b41a16c08..fd44d30ca 100644 --- a/model/Software/Properties/packageVersion.md +++ b/model/Software/Properties/packageVersion.md @@ -16,3 +16,12 @@ changes of the package version. - name: packageVersion - Nature: DataProperty - Range: xsd:string + +## Summary @zh-Hans + +用于标识软件包的版本 + +## Description @zh-Hans + +一个软件包版本（`packageVersion`）对于识别目的和指示软件包版本的后续更改非常有用。 + diff --git a/model/Software/Properties/primaryPurpose.md b/model/Software/Properties/primaryPurpose.md index 5f9acbd66..0d5371100 100644 --- a/model/Software/Properties/primaryPurpose.md +++ b/model/Software/Properties/primaryPurpose.md @@ -16,3 +16,11 @@ artifact. - name: primaryPurpose - Nature: ObjectProperty - Range: SoftwarePurpose + +## Summary @zh-Hans + +提供有关软件工件主要目的的信息。 + +## Description @zh-Hans + +主要目的(`primaryPurpose`)提供了有关软件工件主要目的的信息。 diff --git a/model/Software/Properties/sbomType.md b/model/Software/Properties/sbomType.md index 060ff1014..72affd836 100644 --- a/model/Software/Properties/sbomType.md +++ b/model/Software/Properties/sbomType.md @@ -22,3 +22,15 @@ Aligning with the guidance produced in - name: sbomType - Nature: ObjectProperty - Range: SbomType + +## Summary @zh-Hans + +提供关于软件物料清单（SBOM）类型的信息。 + +## Description @zh-Hans + +这个字段是从创建者的角度合理估计所创建SBOM的类型。 + +它旨在用于指导可能包含在其内的成分。 + +与《软件物料清单（SBOM）文档类型》（[Types of Software Bill of Material (SBOM) Documents](https://www.cisa.gov/sites/default/files/2023-04/sbom-types-document-508c.pdf)）中产生的指导方针保持一致。 diff --git a/model/Software/Properties/snippetFromFile.md b/model/Software/Properties/snippetFromFile.md index 9c5fdc127..5326c9ec7 100644 --- a/model/Software/Properties/snippetFromFile.md +++ b/model/Software/Properties/snippetFromFile.md @@ -15,3 +15,11 @@ The field identifies the file which contains the snippet. - name: snippetFromFile - Nature: ObjectProperty - Range: File + +## Summary @zh-Hans + +定义了代码片段信息所来自的原始宿主文件。 + +## Description @zh-Hans + +该字段标识包含某个代码片段所对应的文件。 diff --git a/model/Software/Properties/sourceInfo.md b/model/Software/Properties/sourceInfo.md index 3b2284d24..01dc3bb6e 100644 --- a/model/Software/Properties/sourceInfo.md +++ b/model/Software/Properties/sourceInfo.md @@ -23,3 +23,15 @@ discoveries in the determination of the origin of the package. - name: sourceInfo - Nature: DataProperty - Range: xsd:string + +## Summary @zh-Hans + +记录有关软件包来源的任何相关背景信息或额外评论。 + +## Description @zh-Hans + +来源信息（`sourceInfo`）用于记录有关软件包来源的任何相关背景信息或额外评论 + +例如，这个字段可能包含注释，指出软件包是否从一个源代码管理系统中拉取，或者是否已经被重新打包。 + +SBOM创建者可以提供额外的信息来描述在确定软件包来源过程中遇到的任何异常或发现。 diff --git a/model/Software/Software.md b/model/Software/Software.md index bde31af39..07337a47b 100644 --- a/model/Software/Software.md +++ b/model/Software/Software.md @@ -14,3 +14,11 @@ The Software namespace defines concepts related to software artifacts. - id: https://spdx.org/rdf/3.0.1/terms/Software - name: Software + +## Summary @zh-Hans + +与软件相关的全部属性及规范. + +## Description @zh-Hans + +软件（`Software`）命名空间定义了与软件工件相关的概念。 diff --git a/model/Software/Vocabularies/ContentIdentifierType.md b/model/Software/Vocabularies/ContentIdentifierType.md index 44c0ddd9f..9c0f6be4c 100644 --- a/model/Software/Vocabularies/ContentIdentifierType.md +++ b/model/Software/Vocabularies/ContentIdentifierType.md @@ -18,3 +18,17 @@ ContentIdentifierType specifies the type of a content identifier. - gitoid: [Gitoid](https://www.iana.org/assignments/uri-schemes/prov/gitoid), stands for [Git Object ID](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). A gitoid of type blob is a unique hash of a binary artifact. A gitoid may represent either an [Artifact Identifier](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-identifier-types) for the software artifact or an [Input Manifest Identifier](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#input-manifest-identifier) for the software artifact's associated [Artifact Input Manifest](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-input-manifest); this ambiguity exists because the Artifact Input Manifest is itself an artifact, and the gitoid of that artifact is its valid identifier. Gitoids calculated on software artifacts (Snippet, File, or Package Elements) should be recorded in the SPDX 3.0 SoftwareArtifact's contentIdentifier property. Gitoids calculated on the Artifact Input Manifest (Input Manifest Identifier) should be recorded in the SPDX 3.0 Element's externalIdentifier property. See [OmniBOR Specification](https://github.com/omnibor/spec/), a minimalistic specification for describing software [Artifact Dependency Graphs](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-dependency-graph-adg). - swhid: SoftWare Hash IDentifier, a persistent intrinsic identifier for digital artifacts, such as files, trees (also known as directories or folders), commits, and other objects typically found in version control systems. The format of the identifiers is defined in the [SWHID specification](https://www.swhid.org/specification/v1.1/4.Syntax) (ISO/IEC DIS 18670). They typically look like `swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2`. + +## Summary @zh-Hans + +指定内容标识符的类型。 + +## Description @zh-Hans + +内容标识符类型（`ContentIdentifierType`）指定了内容标识符的类型。 + +## Entries @zh-Hans + +- gitoid：[Gitoid](https://www.iana.org/assignments/uri-schemes/prov/gitoid)代表 [Git Object ID](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects)。类型为blob的gitoid是二进制工件的唯一哈希值。gitoid可以代表软件工件的工件标识符（[Artifact Identifier](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-identifier-types)），也可以代表软件工件相关联的工件输入清单（ [Artifact Input Manifest](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-input-manifest)）的输入清单标识符（[Input Manifest Identifier](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#input-manifest-identifier)）；这种模糊性存在是因为工件输入清单本身也是一个工件，而该工件的gitoid就是其有效的标识符。在软件工件（如代码片段、文件或包元素）上计算的Gitoids应该记录在SPDX 3.0 SoftwareArtifact的内容标识符（contentIdentifier）属性中。在工件输入清单（Artifact Input Manifest，输入清单标识符）上计算的Gitoids应该记录在SPDX 3.0元素的外部标识符（externalIdentifier）属性中。参见OmniBOR规范（[OmniBOR Specification](https://github.com/omnibor/spec/)），这是一个描述软件工件依赖图（[Artifact Dependency Graphs](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-dependency-graph-adg)）的极简规范。 + +- swhid：软件哈希标识符，是一种用于数字工件的持久内在标识符，这些数字工件包括文件、树（也称为目录或文件夹）、commits（提交）以及其他通常在版本控制系统中找到的对象。这些标识符的格式在SWHID规范（ [SWHID specification](https://www.swhid.org/specification/v1.1/4.Syntax)）（ISO/IEC DIS 18670）中定义。它们通常看起来像这样 `swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2`。 diff --git a/model/Software/Vocabularies/FileKindType.md b/model/Software/Vocabularies/FileKindType.md index edf68851e..8bd7da51c 100644 --- a/model/Software/Vocabularies/FileKindType.md +++ b/model/Software/Vocabularies/FileKindType.md @@ -20,3 +20,19 @@ In the future, this may be extended to other kinds (e.g. network based files). - file: The file represents a single file (default). - directory: The file represents a directory and all content stored in that directory. + +## Summary @zh-Hans + +SPDX文件不同类型的枚举。 + +## Description @zh-Hans + +一个SPDX文件可以代表磁盘上的一个文件或者一个文件目录。 + +将来，这可能会扩展到其他类型（例如，基于网络的文件）。 + +## Entries @zh-Hans + +- 文件（file）:文件代表一个单独的文件（默认）。 + +- 目录（directory）:文件代表一个目录以及存储在该目录中的所有内容。 diff --git a/model/Software/Vocabularies/SbomType.md b/model/Software/Vocabularies/SbomType.md index aa54f8677..9aba0e489 100644 --- a/model/Software/Vocabularies/SbomType.md +++ b/model/Software/Vocabularies/SbomType.md @@ -31,3 +31,25 @@ A single SBOM can have multiple SBOM document types associated with it. - deployed: SBOM provides an inventory of software that is present on a system. This may be an assembly of other SBOMs that combines analysis of configuration options, and examination of execution behavior in a (potentially simulated) deployment environment. - runtime: SBOM generated through instrumenting the system running the software, to capture only components present in the system, as well as external call-outs or dynamically loaded components. In some contexts, this may also be referred to as an "Instrumented" or "Dynamic" SBOM. - analyzed: SBOM generated through analysis of artifacts (e.g., executables, packages, containers, and virtual machine images) after its build. Such analysis generally requires a variety of heuristics. In some contexts, this may also be referred to as a "3rd party" SBOM. + +## Summary @zh-Hans + +提供一组值，用于描述工具可能创建的常见SBOM（软件物料清单）类型。 + + +## Description @zh-Hans + +在2023年4月21日发布的《软件物料清单（SBOM）文档类型》（[Types of Software Bill of Material (SBOM) Documents](https://www.cisa.gov/sites/default/files/2023-04/sbom-types-document-508c.pdf)）中定义的SBOM类型集合及其定义。 + +SBOM类型从生产者的角度描述了SBOM的最可能类型，以便消费者可以对SBOM内的数据得出结论。 + +一个SBOM可以与多个SBOM文档类型相关联。 + +## Entries @zh-Hans + +- 设计（design）: SBOM是针对预期的、计划中的软件项目或产品，包括了新软件工件的组成部分（其中一些可能尚不存在）。 +- 源代码（source）: 直接从开发环境、源文件和用于构建产品包的依赖关系中创建的SBOM。 +- 构建（build）: 在构建软件的过程中生成的SBOM，以从源文件、依赖关系、构建组件、构建过程临时数据和其他SBOMs等数据中创建一个可发布的工件（例如，可执行文件或包）。 +- 部署态（deployed）: SBOM提供了系统上存在的软件清单。这可能是其他SBOM的组合，结合了配置选项的分析和在（可能是模拟的）部署环境中执行行为的检查。 +- 运行时（runtime）: 通过监控系统运行软件生成的SBOM，以捕获系统中存在的组件以及外部调用或动态加载的组件。在某些情况下，这也可能被称为“监控”或“动态”SBOM。 +- 分析（analyzed）: 在构建工件后，通过对工件（例如，可执行文件、包、容器和虚拟机镜像）进行分析生成的SBOM。这种分析通常需要多种启发式方法。在某些情况下，这也可能被称为“第三方”SBOM。 diff --git a/model/Software/Vocabularies/SoftwarePurpose.md b/model/Software/Vocabularies/SoftwarePurpose.md index ac495161e..91b171c75 100644 --- a/model/Software/Vocabularies/SoftwarePurpose.md +++ b/model/Software/Vocabularies/SoftwarePurpose.md @@ -52,3 +52,47 @@ conclusions about the context in which the Element exists. - source: The Element is a single or a collection of source files. - specification: The Element is a plan, guideline or strategy how to create, perform or analyze an application. - test: The Element is a test used to verify functionality on an software element. + +## Summary @zh-Hans + +提供有关元素的主要目的信息。 + +## Description @zh-Hans + +该字段提供了有关元素的主要目的信息。 + +软件目的与元素的使用方式内在相关，而不是元素的内容。 + +这个字段是对元素最可能用途的合理估计，从生产者和消费者的角度来看，双方都可以从中得出关于元素存在的上下文的结论。 + +## Entries @zh-Hans + +- 应用程序（application）: 该元素是一个软件应用程序。 +- 归档文件（archive）: 该元素是一个或多个文件的归档集合（如.tar、.zip等）。 +- 物料清单（bom）: 该元素是一个物料清单。 +- 配置数据（configuration）: 该元素是配置数据。 +- 容器（container）: 该元素是一个容器镜像，可以被容器运行时应用程序使用。 +- 数据（data）: 该元素是数据。 +- 设备（device）: 该元素指的是芯片模组、处理器或电路板。 +- 磁盘映像（diskImage）: 该元素指的是可以写入磁盘、在虚拟机中启动等的磁盘映像。磁盘映像通常包含启动所需的大部分或全部组件，如引导加载程序、内核、固件、用户空间等。 +- 设备驱动程序（deviceDriver）: 该元素代表控制硬件设备的软件。 +- 文档（documentation）: 该元素是文档。 +- 证据（evidence）: 该元素是证明规范或要求已得到满足的证据。 +- 可执行文件（executable）: 该元素是可以计算机上运行的工件。 +- 文件（file）: 该元素是一个可以独立分发的单个文件（配置文件、静态链接的二进制文件、Kubernetes部署等）。 +- 文件系统映像（filesystemImage）: 该元素是一个可以写入磁盘（或虚拟）分区的文件系统映像。 +- 固件（firmware）: 该元素提供对设备硬件的低级控制。 +- 框架（framework）: 该元素是一个软件框架。 +- 安装程序（install）: 该元素用于在磁盘上安装软件。 +- 库（library）: 该元素是一个软件库。 +- 清单（manifest）: 该元素是一个软件清单。 +- 模型（model）: 该元素是机器学习或人工智能模型。 +- 模块（module）: 该元素是软件的一个模块。 +- 操作系统（operatingSystem）: 该元素是一个操作系统。 +- 其他（other）: 该元素不属于其他任何类别。 +- 补丁（patch）: 该元素包含一组用于更新、修复或改进另一个元素的更改。 +- 平台（platform）: 该元素代表一个运行时环境。 +- 需求（requirement）: 该元素提供了作为另一个元素输入所需的需求。 +- 源代码（source）: 该元素是单个或一组源代码文件。 +- 规范（specification）: 该元素是一个计划、指南或策略，说明如何创建、执行或分析应用程序。 +- 测试（test）: 该元素是用来验证软件元素功能的测试。 From 16b0bb1c91e79d2420afa0f05a611d5d3998a3c5 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Sun, 5 Jan 2025 04:14:45 +0000 Subject: [PATCH 02/19] No double blank lines I will commit trivial minor suggested changes here, so we can focus on the question of entry names Signed-off-by: Arthit Suriyawongkul --- model/Software/Classes/ContentIdentifier.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/model/Software/Classes/ContentIdentifier.md b/model/Software/Classes/ContentIdentifier.md index 982d749be..4bddc4794 100644 --- a/model/Software/Classes/ContentIdentifier.md +++ b/model/Software/Classes/ContentIdentifier.md @@ -29,8 +29,6 @@ It can be used for verifying its identity and integrity. - type: xsd:anyURI - minCount: 1 - maxCount: 1 - - ## Summary @zh-Hans 一个规范的、唯一的、不可变的标识符。 From 96d7bf37ffa452e1d47f2c7d457b33f278ae07fc Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Sun, 5 Jan 2025 04:15:40 +0000 Subject: [PATCH 03/19] Use - (dash) for bullet list (instead of *) I will commit trivial minor suggested changes here, so we can focus on the question of entry names Signed-off-by: Arthit Suriyawongkul --- model/Software/Properties/copyrightText.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/model/Software/Properties/copyrightText.md b/model/Software/Properties/copyrightText.md index 632836cc4..0428c2a85 100644 --- a/model/Software/Properties/copyrightText.md +++ b/model/Software/Properties/copyrightText.md @@ -51,10 +51,8 @@ value as described above. 如果版权文本的值为“NOASSERTION”，则表示以下情况之一适用： -* SPDX数据创建者已尝试但无法达到合理的客观判断； - -* SPDX数据创建者没有尝试确定此字段； - -* SPDX数据创建者故意没有提供信息（这样做不应推断任何含义）。 +- SPDX数据创建者已尝试但无法达到合理的客观判断； +- SPDX数据创建者没有尝试确定此字段； +- SPDX数据创建者故意没有提供信息（这样做不应推断任何含义）。 如果版权文本存在，但仅由空字符串或没有实质内容的字符串组成（例如，只包含空格的字符串），那么这应该被解释为等同于上述“NOASSERTION”值。 From 2ec6165889d24e961321e6429ccd19b0ed8f4779 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Sun, 5 Jan 2025 04:16:24 +0000 Subject: [PATCH 04/19] Remove https:// prefix from local file link I will commit trivial minor suggested changes here, so we can focus on the question of entry names Signed-off-by: Arthit Suriyawongkul --- model/Software/Properties/packageUrl.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/model/Software/Properties/packageUrl.md b/model/Software/Properties/packageUrl.md index 7bee2691f..b85ce360d 100644 --- a/model/Software/Properties/packageUrl.md +++ b/model/Software/Properties/packageUrl.md @@ -51,6 +51,7 @@ significant on the left to the least significant components on the right. scheme:type/namespace/name@version?qualifiers#subpath ``` -每个组件的定义可以在本规范的相应附录([Annex](https://../../../annexes/pkg-url-specification.md))中找到。已知类型的类型定义([type definitions](https://github.com/package-url/purl-spec/blob/b33dda1cf4515efa8eabbbe8e9b140950805f845/PURL-TYPES.rst).)可以在包URL类型定义中找到。 +每个组件的定义可以在本规范的相应附录([Annex](../../../annexes/pkg-url-specification.md))中找到。 +已知类型的类型定义([type definitions](https://github.com/package-url/purl-spec/blob/b33dda1cf4515efa8eabbbe8e9b140950805f845/PURL-TYPES.rst))可以在包URL类型定义中找到。 组件的设计方式是，它们从最左边的最重要的组件到最右边的最不重要的组件形成一个层次结构。 From 5564f7abcf42774f3671b5cc8d226cd02f967932 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Sun, 5 Jan 2025 04:17:05 +0000 Subject: [PATCH 05/19] Use - (dash) for bullet list (instead of *) I will commit trivial minor suggested changes here, so we can focus on the question of entry names Signed-off-by: Arthit Suriyawongkul --- model/Software/Classes/Package.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/model/Software/Classes/Package.md b/model/Software/Classes/Package.md index faf532fc6..f5e02e1c6 100644 --- a/model/Software/Classes/Package.md +++ b/model/Software/Classes/Package.md @@ -72,11 +72,11 @@ Note that some of these could be represented in SPDX as a file as well. 在SPDX中表达一个软件包，包含但不限于以下示例： -* 一个tar,zip或其他压缩文件 -* 一个目录或者子目录 -* 一个被其他包或文件使用或依赖的独立分发软件(例如 一个Python包, 一个 Go 模块 ...) -* 一个容器镜像，以及/或者容器镜像里的一个镜像层 -* 一个或多个子包的集合 -* 一个特定时间点的git代码仓库快照 +- 一个tar,zip或其他压缩文件 +- 一个目录或者子目录 +- 一个被其他包或文件使用或依赖的独立分发软件(例如 一个Python包, 一个 Go 模块 ...) +- 一个容器镜像，以及/或者容器镜像里的一个镜像层 +- 一个或多个子包的集合 +- 一个特定时间点的git代码仓库快照 需要注意的是上述内容中的一些也可以在SPDX中被表示为文件。 From f4ef8ea5732f7c042da62e47ffda7875e6344dbd Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Sun, 5 Jan 2025 04:22:45 +0000 Subject: [PATCH 06/19] No double blank lines I will commit trivial minor change suggestions here, so we can focus on the question of entry names. Signed-off-by: Arthit Suriyawongkul --- model/SimpleLicensing/Properties/licenseExpression.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/model/SimpleLicensing/Properties/licenseExpression.md b/model/SimpleLicensing/Properties/licenseExpression.md index 9670c1e38..67fe0a091 100644 --- a/model/SimpleLicensing/Properties/licenseExpression.md +++ b/model/SimpleLicensing/Properties/licenseExpression.md @@ -26,8 +26,6 @@ license expression as a combination of license objects. - name: licenseExpression - Nature: DataProperty - Range: xsd:string - - ## Summary @zh-Hans 许可证表达式格式的字符串。 From 518ab0251b055196c96539d7b0f5f6b72cc4cb7b Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Sun, 5 Jan 2025 04:22:58 +0000 Subject: [PATCH 07/19] No double blank lines I will commit trivial minor change suggestions here, so we can focus on the question of entry names. Signed-off-by: Arthit Suriyawongkul --- model/SimpleLicensing/Properties/customIdToUri.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/model/SimpleLicensing/Properties/customIdToUri.md b/model/SimpleLicensing/Properties/customIdToUri.md index 9cfeffe4e..f3e9494b2 100644 --- a/model/SimpleLicensing/Properties/customIdToUri.md +++ b/model/SimpleLicensing/Properties/customIdToUri.md @@ -29,8 +29,6 @@ CustomLicenseAddition, or SimpleLicensingText. - name: customIdToUri - Nature: ObjectProperty - Range: /Core/DictionaryEntry - - ## Summary @zh-Hans 将自定义许可证或自定义许可证附加信息的`LicenseRef`或`AdditionRef`字符串映射到其URI ID上。 From ae25fbf5b83ae440d978697b7cb812cffeaa7d38 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Sun, 5 Jan 2025 04:23:20 +0000 Subject: [PATCH 08/19] One one line before and after the list I will commit trivial minor change suggestions here, so we can focus on the question of entry names. Signed-off-by: Arthit Suriyawongkul --- model/Software/Classes/ContentIdentifier.md | 1 + 1 file changed, 1 insertion(+) diff --git a/model/Software/Classes/ContentIdentifier.md b/model/Software/Classes/ContentIdentifier.md index 4bddc4794..5a1902ed8 100644 --- a/model/Software/Classes/ContentIdentifier.md +++ b/model/Software/Classes/ContentIdentifier.md @@ -29,6 +29,7 @@ It can be used for verifying its identity and integrity. - type: xsd:anyURI - minCount: 1 - maxCount: 1 + ## Summary @zh-Hans 一个规范的、唯一的、不可变的标识符。 From c594d70fdc489976349495d3e734d1728c0ac966 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Sun, 5 Jan 2025 04:23:42 +0000 Subject: [PATCH 09/19] Keep same formatting as English ver I will commit trivial minor change suggestions here, so we can focus on the question of entry names. Signed-off-by: Arthit Suriyawongkul --- model/Software/Vocabularies/ContentIdentifierType.md | 1 - 1 file changed, 1 deletion(-) diff --git a/model/Software/Vocabularies/ContentIdentifierType.md b/model/Software/Vocabularies/ContentIdentifierType.md index 9c0f6be4c..83cf85151 100644 --- a/model/Software/Vocabularies/ContentIdentifierType.md +++ b/model/Software/Vocabularies/ContentIdentifierType.md @@ -30,5 +30,4 @@ ContentIdentifierType specifies the type of a content identifier. ## Entries @zh-Hans - gitoid：[Gitoid](https://www.iana.org/assignments/uri-schemes/prov/gitoid)代表 [Git Object ID](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects)。类型为blob的gitoid是二进制工件的唯一哈希值。gitoid可以代表软件工件的工件标识符（[Artifact Identifier](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-identifier-types)），也可以代表软件工件相关联的工件输入清单（ [Artifact Input Manifest](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-input-manifest)）的输入清单标识符（[Input Manifest Identifier](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#input-manifest-identifier)）；这种模糊性存在是因为工件输入清单本身也是一个工件，而该工件的gitoid就是其有效的标识符。在软件工件（如代码片段、文件或包元素）上计算的Gitoids应该记录在SPDX 3.0 SoftwareArtifact的内容标识符（contentIdentifier）属性中。在工件输入清单（Artifact Input Manifest，输入清单标识符）上计算的Gitoids应该记录在SPDX 3.0元素的外部标识符（externalIdentifier）属性中。参见OmniBOR规范（[OmniBOR Specification](https://github.com/omnibor/spec/)），这是一个描述软件工件依赖图（[Artifact Dependency Graphs](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-dependency-graph-adg)）的极简规范。 - - swhid：软件哈希标识符，是一种用于数字工件的持久内在标识符，这些数字工件包括文件、树（也称为目录或文件夹）、commits（提交）以及其他通常在版本控制系统中找到的对象。这些标识符的格式在SWHID规范（ [SWHID specification](https://www.swhid.org/specification/v1.1/4.Syntax)）（ISO/IEC DIS 18670）中定义。它们通常看起来像这样 `swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2`。 From 637cf280b882558a9d2c87d709065cff0440fba5 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Sun, 5 Jan 2025 04:23:57 +0000 Subject: [PATCH 10/19] No double blank lines I will commit trivial minor change suggestions here, so we can focus on the question of entry names. Signed-off-by: Arthit Suriyawongkul --- model/Software/Vocabularies/SbomType.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/model/Software/Vocabularies/SbomType.md b/model/Software/Vocabularies/SbomType.md index 9aba0e489..869921f76 100644 --- a/model/Software/Vocabularies/SbomType.md +++ b/model/Software/Vocabularies/SbomType.md @@ -35,8 +35,6 @@ A single SBOM can have multiple SBOM document types associated with it. ## Summary @zh-Hans 提供一组值，用于描述工具可能创建的常见SBOM（软件物料清单）类型。 - - ## Description @zh-Hans 在2023年4月21日发布的《软件物料清单（SBOM）文档类型》（[Types of Software Bill of Material (SBOM) Documents](https://www.cisa.gov/sites/default/files/2023-04/sbom-types-document-508c.pdf)）中定义的SBOM类型集合及其定义。 From 3bfa3c177f5e85b85ed9bc28021a0e895030efae Mon Sep 17 00:00:00 2001 From: Zhenyu Zheng Date: Mon, 20 Jan 2025 14:31:47 +0800 Subject: [PATCH 11/19] Update model/Software/Vocabularies/SoftwarePurpose.md Co-authored-by: Arthit Suriyawongkul Signed-off-by: Zhenyu Zheng --- .../Software/Vocabularies/SoftwarePurpose.md | 58 +++++++++---------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/model/Software/Vocabularies/SoftwarePurpose.md b/model/Software/Vocabularies/SoftwarePurpose.md index 91b171c75..3bd6ff66b 100644 --- a/model/Software/Vocabularies/SoftwarePurpose.md +++ b/model/Software/Vocabularies/SoftwarePurpose.md @@ -67,32 +67,32 @@ conclusions about the context in which the Element exists. ## Entries @zh-Hans -- 应用程序（application）: 该元素是一个软件应用程序。 -- 归档文件（archive）: 该元素是一个或多个文件的归档集合（如.tar、.zip等）。 -- 物料清单（bom）: 该元素是一个物料清单。 -- 配置数据（configuration）: 该元素是配置数据。 -- 容器（container）: 该元素是一个容器镜像，可以被容器运行时应用程序使用。 -- 数据（data）: 该元素是数据。 -- 设备（device）: 该元素指的是芯片模组、处理器或电路板。 -- 磁盘映像（diskImage）: 该元素指的是可以写入磁盘、在虚拟机中启动等的磁盘映像。磁盘映像通常包含启动所需的大部分或全部组件，如引导加载程序、内核、固件、用户空间等。 -- 设备驱动程序（deviceDriver）: 该元素代表控制硬件设备的软件。 -- 文档（documentation）: 该元素是文档。 -- 证据（evidence）: 该元素是证明规范或要求已得到满足的证据。 -- 可执行文件（executable）: 该元素是可以计算机上运行的工件。 -- 文件（file）: 该元素是一个可以独立分发的单个文件（配置文件、静态链接的二进制文件、Kubernetes部署等）。 -- 文件系统映像（filesystemImage）: 该元素是一个可以写入磁盘（或虚拟）分区的文件系统映像。 -- 固件（firmware）: 该元素提供对设备硬件的低级控制。 -- 框架（framework）: 该元素是一个软件框架。 -- 安装程序（install）: 该元素用于在磁盘上安装软件。 -- 库（library）: 该元素是一个软件库。 -- 清单（manifest）: 该元素是一个软件清单。 -- 模型（model）: 该元素是机器学习或人工智能模型。 -- 模块（module）: 该元素是软件的一个模块。 -- 操作系统（operatingSystem）: 该元素是一个操作系统。 -- 其他（other）: 该元素不属于其他任何类别。 -- 补丁（patch）: 该元素包含一组用于更新、修复或改进另一个元素的更改。 -- 平台（platform）: 该元素代表一个运行时环境。 -- 需求（requirement）: 该元素提供了作为另一个元素输入所需的需求。 -- 源代码（source）: 该元素是单个或一组源代码文件。 -- 规范（specification）: 该元素是一个计划、指南或策略，说明如何创建、执行或分析应用程序。 -- 测试（test）: 该元素是用来验证软件元素功能的测试。 +- application: (应用程序) 该元素是一个软件应用程序。 +- archive: (归档文件) 该元素是一个或多个文件的归档集合（如.tar、.zip等）。 +- bom: (物料清单) 该元素是一个物料清单。 +- configuration: (配置数据) 该元素是配置数据。 +- container: (容器) 该元素是一个容器镜像，可以被容器运行时应用程序使用。 +- data: (数据) 该元素是数据。 +- device: (设备) 该元素指的是芯片模组、处理器或电路板。 +- diskImage: (磁盘映像) 该元素指的是可以写入磁盘、在虚拟机中启动等的磁盘映像。磁盘映像通常包含启动所需的大部分或全部组件，如引导加载程序、内核、固件、用户空间等。 +- deviceDriver: (设备驱动程序) 该元素代表控制硬件设备的软件。 +- documentation: (文档) 该元素是文档。 +- evidence: (证据) 该元素是证明规范或要求已得到满足的证据。 +- executable: (可执行文件) 该元素是可以计算机上运行的工件。 +- file: (文件) 该元素是一个可以独立分发的单个文件（配置文件、静态链接的二进制文件、Kubernetes部署等）。 +- filesystemImage: (文件系统映像) 该元素是一个可以写入磁盘（或虚拟）分区的文件系统映像。 +- firmware: (固件) 该元素提供对设备硬件的低级控制。 +- framework: (框架) 该元素是一个软件框架。 +- install: (安装程序) 该元素用于在磁盘上安装软件。 +- library: (库) 该元素是一个软件库。 +- manifest: (清单) 该元素是一个软件清单。 +- model: (模型) 该元素是机器学习或人工智能模型。 +- module: (模块) 该元素是软件的一个模块。 +- operatingSystem: (操作系统) 该元素是一个操作系统。 +- other: (其他) 该元素不属于其他任何类别。 +- patch: (补丁) 该元素包含一组用于更新、修复或改进另一个元素的更改。 +- platform: (平台) 该元素代表一个运行时环境。 +- requirement: (需求) 该元素提供了作为另一个元素输入所需的需求。 +- source: (源代码) 该元素是单个或一组源代码文件。 +- specification: (规范) 该元素是一个计划、指南或策略，说明如何创建、执行或分析应用程序。 +- test: (测试) 该元素是用来验证软件元素功能的测试。 From 7ee2266ea09be7f12778783e5bebba271d17cb6d Mon Sep 17 00:00:00 2001 From: Zhenyu Zheng Date: Mon, 20 Jan 2025 14:31:58 +0800 Subject: [PATCH 12/19] Update model/Software/Vocabularies/SbomType.md Co-authored-by: Arthit Suriyawongkul Signed-off-by: Zhenyu Zheng --- model/Software/Vocabularies/SbomType.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/model/Software/Vocabularies/SbomType.md b/model/Software/Vocabularies/SbomType.md index 869921f76..659ffcc62 100644 --- a/model/Software/Vocabularies/SbomType.md +++ b/model/Software/Vocabularies/SbomType.md @@ -45,9 +45,9 @@ SBOM类型从生产者的角度描述了SBOM的最可能类型，以便消费者 ## Entries @zh-Hans -- 设计（design）: SBOM是针对预期的、计划中的软件项目或产品，包括了新软件工件的组成部分（其中一些可能尚不存在）。 -- 源代码（source）: 直接从开发环境、源文件和用于构建产品包的依赖关系中创建的SBOM。 -- 构建（build）: 在构建软件的过程中生成的SBOM，以从源文件、依赖关系、构建组件、构建过程临时数据和其他SBOMs等数据中创建一个可发布的工件（例如，可执行文件或包）。 -- 部署态（deployed）: SBOM提供了系统上存在的软件清单。这可能是其他SBOM的组合，结合了配置选项的分析和在（可能是模拟的）部署环境中执行行为的检查。 -- 运行时（runtime）: 通过监控系统运行软件生成的SBOM，以捕获系统中存在的组件以及外部调用或动态加载的组件。在某些情况下，这也可能被称为“监控”或“动态”SBOM。 -- 分析（analyzed）: 在构建工件后，通过对工件（例如，可执行文件、包、容器和虚拟机镜像）进行分析生成的SBOM。这种分析通常需要多种启发式方法。在某些情况下，这也可能被称为“第三方”SBOM。 +- design: (设计) SBOM是针对预期的、计划中的软件项目或产品，包括了新软件工件的组成部分（其中一些可能尚不存在）。 +- source: (源代码) 直接从开发环境、源文件和用于构建产品包的依赖关系中创建的SBOM。 +- build: (构建) 在构建软件的过程中生成的SBOM，以从源文件、依赖关系、构建组件、构建过程临时数据和其他SBOMs等数据中创建一个可发布的工件（例如，可执行文件或包）。 +- deployed: (部署态) SBOM提供了系统上存在的软件清单。这可能是其他SBOM的组合，结合了配置选项的分析和在（可能是模拟的）部署环境中执行行为的检查。 +- runtime: (运行时) 通过监控系统运行软件生成的SBOM，以捕获系统中存在的组件以及外部调用或动态加载的组件。在某些情况下，这也可能被称为“监控”或“动态”SBOM。 +- analyzed: (分析) 在构建工件后，通过对工件（例如，可执行文件、包、容器和虚拟机镜像）进行分析生成的SBOM。这种分析通常需要多种启发式方法。在某些情况下，这也可能被称为“第三方”SBOM。 From 5d2409fdf9d0765d8b56729fea751c5578f0e938 Mon Sep 17 00:00:00 2001 From: Zhenyu Zheng Date: Mon, 20 Jan 2025 14:33:57 +0800 Subject: [PATCH 13/19] Update model/Software/Vocabularies/FileKindType.md Co-authored-by: Arthit Suriyawongkul Signed-off-by: Zhenyu Zheng --- model/Software/Vocabularies/FileKindType.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/model/Software/Vocabularies/FileKindType.md b/model/Software/Vocabularies/FileKindType.md index 8bd7da51c..ee62bef01 100644 --- a/model/Software/Vocabularies/FileKindType.md +++ b/model/Software/Vocabularies/FileKindType.md @@ -33,6 +33,5 @@ SPDX文件不同类型的枚举。 ## Entries @zh-Hans -- 文件（file）:文件代表一个单独的文件（默认）。 - -- 目录（directory）:文件代表一个目录以及存储在该目录中的所有内容。 +- file: (文件) 文件代表一个单独的文件（默认）。 +- directory: (目录) 文件代表一个目录以及存储在该目录中的所有内容。 From 98de72652484414d942d2c91dce74ef31a791c4d Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Mon, 20 Jan 2025 07:59:28 +0000 Subject: [PATCH 14/19] Update model/SimpleLicensing/Classes/AnyLicenseInfo.md Signed-off-by: Arthit Suriyawongkul --- model/SimpleLicensing/Classes/AnyLicenseInfo.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/model/SimpleLicensing/Classes/AnyLicenseInfo.md b/model/SimpleLicensing/Classes/AnyLicenseInfo.md index 242501b4d..a251a5193 100644 --- a/model/SimpleLicensing/Classes/AnyLicenseInfo.md +++ b/model/SimpleLicensing/Classes/AnyLicenseInfo.md @@ -42,8 +42,6 @@ It can be: `AnyLicenseInfo`是一个抽象类，表示由一个或多个许可证（可选包括附加文本）组成的许可证组合，这些许可证可根据[SPDX许可证表达式语法](../../../annexes/spdx-license-expressions.md)进行组合。 `AnyLicenseInfo`可用于软件工件的许可属性。 - - 它可以是 - `NoneLicense`； - `NoAssertionLicense`； From a2a4721174cf42b02f0461b77d79394b3e357de6 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Mon, 20 Jan 2025 07:59:40 +0000 Subject: [PATCH 15/19] Update model/SimpleLicensing/Properties/customIdToUri.md Signed-off-by: Arthit Suriyawongkul --- model/SimpleLicensing/Properties/customIdToUri.md | 1 + 1 file changed, 1 insertion(+) diff --git a/model/SimpleLicensing/Properties/customIdToUri.md b/model/SimpleLicensing/Properties/customIdToUri.md index f3e9494b2..481c65325 100644 --- a/model/SimpleLicensing/Properties/customIdToUri.md +++ b/model/SimpleLicensing/Properties/customIdToUri.md @@ -29,6 +29,7 @@ CustomLicenseAddition, or SimpleLicensingText. - name: customIdToUri - Nature: ObjectProperty - Range: /Core/DictionaryEntry + ## Summary @zh-Hans 将自定义许可证或自定义许可证附加信息的`LicenseRef`或`AdditionRef`字符串映射到其URI ID上。 From 892ac39aa8c21d88a78e0f04cf4e92793952c3fb Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Mon, 20 Jan 2025 07:59:51 +0000 Subject: [PATCH 16/19] Update model/SimpleLicensing/Properties/licenseExpression.md Signed-off-by: Arthit Suriyawongkul --- model/SimpleLicensing/Properties/licenseExpression.md | 1 + 1 file changed, 1 insertion(+) diff --git a/model/SimpleLicensing/Properties/licenseExpression.md b/model/SimpleLicensing/Properties/licenseExpression.md index 67fe0a091..2213e3819 100644 --- a/model/SimpleLicensing/Properties/licenseExpression.md +++ b/model/SimpleLicensing/Properties/licenseExpression.md @@ -26,6 +26,7 @@ license expression as a combination of license objects. - name: licenseExpression - Nature: DataProperty - Range: xsd:string + ## Summary @zh-Hans 许可证表达式格式的字符串。 From 85b174b2ea6f264e47d600ba57da67cf1651139c Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Mon, 20 Jan 2025 08:00:03 +0000 Subject: [PATCH 17/19] Update model/Software/Classes/Package.md Signed-off-by: Arthit Suriyawongkul --- model/Software/Classes/Package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/model/Software/Classes/Package.md b/model/Software/Classes/Package.md index f5e02e1c6..2dcd93e24 100644 --- a/model/Software/Classes/Package.md +++ b/model/Software/Classes/Package.md @@ -66,7 +66,7 @@ Note that some of these could be represented in SPDX as a file as well. ## Description @zh-Hans - 包(`Package`)指与软件分发相关的任何内容单元。 +包(`Package`)指与软件分发相关的任何内容单元。 通常，一个软件包由一个或多个文件组成。 From a810b6a34ac66b4ca214894b5b2be40759f535f0 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Mon, 20 Jan 2025 08:00:14 +0000 Subject: [PATCH 18/19] Update model/Software/Vocabularies/SbomType.md Signed-off-by: Arthit Suriyawongkul --- model/Software/Vocabularies/SbomType.md | 1 + 1 file changed, 1 insertion(+) diff --git a/model/Software/Vocabularies/SbomType.md b/model/Software/Vocabularies/SbomType.md index 659ffcc62..4e81a43cd 100644 --- a/model/Software/Vocabularies/SbomType.md +++ b/model/Software/Vocabularies/SbomType.md @@ -35,6 +35,7 @@ A single SBOM can have multiple SBOM document types associated with it. ## Summary @zh-Hans 提供一组值，用于描述工具可能创建的常见SBOM（软件物料清单）类型。 + ## Description @zh-Hans 在2023年4月21日发布的《软件物料清单（SBOM）文档类型》（[Types of Software Bill of Material (SBOM) Documents](https://www.cisa.gov/sites/default/files/2023-04/sbom-types-document-508c.pdf)）中定义的SBOM类型集合及其定义。 From 38c429552cc732e45e4946ca5b005f52e8d479f9 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Mon, 20 Jan 2025 08:03:16 +0000 Subject: [PATCH 19/19] Update model/SimpleLicensing/Classes/AnyLicenseInfo.md Signed-off-by: Arthit Suriyawongkul --- model/SimpleLicensing/Classes/AnyLicenseInfo.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/model/SimpleLicensing/Classes/AnyLicenseInfo.md b/model/SimpleLicensing/Classes/AnyLicenseInfo.md index a251a5193..0d2b3fd21 100644 --- a/model/SimpleLicensing/Classes/AnyLicenseInfo.md +++ b/model/SimpleLicensing/Classes/AnyLicenseInfo.md @@ -42,7 +42,9 @@ It can be: `AnyLicenseInfo`是一个抽象类，表示由一个或多个许可证（可选包括附加文本）组成的许可证组合，这些许可证可根据[SPDX许可证表达式语法](../../../annexes/spdx-license-expressions.md)进行组合。 `AnyLicenseInfo`可用于软件工件的许可属性。 + 它可以是 + - `NoneLicense`； - `NoAssertionLicense`； - （在[SPDX许可证列表](https://spdx.org/licenses/)或[自定义许可证](../../ExpandedLicensing/Classes/CustomLicense.md)）的单一许可证；