From 3523ac0ad825a21427408f66f3866e0f6909a69d Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Mon, 9 Sep 2024 12:11:18 +0100 Subject: [PATCH 1/3] Standardised RFC links Signed-off-by: Arthit Suriyawongkul --- model/Core/Datatypes/MediaType.md | 2 +- .../packageVerificationCodeExcludedFile.md | 2 +- .../Vocabularies/ExternalIdentifierType.md | 4 ++-- model/Core/Vocabularies/HashAlgorithm.md | 24 +++++++++---------- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/model/Core/Datatypes/MediaType.md b/model/Core/Datatypes/MediaType.md index 716a40121..007a72346 100644 --- a/model/Core/Datatypes/MediaType.md +++ b/model/Core/Datatypes/MediaType.md @@ -10,7 +10,7 @@ A String constrained to the RFC 2046 specificiation. ## Description A MediaType is a string constrained to the -[RFC 2046 MIME Part Two: Media Types](https://www.rfc-editor.org/info/rfc2046). +[RFC 2046 MIME Part Two: Media Types](https://datatracker.ietf.org/doc/rfc2046). It provides a standardized way of indicating the type of content of an Element or a Property. diff --git a/model/Core/Properties/packageVerificationCodeExcludedFile.md b/model/Core/Properties/packageVerificationCodeExcludedFile.md index f59cd0eb4..fde5c64c1 100644 --- a/model/Core/Properties/packageVerificationCodeExcludedFile.md +++ b/model/Core/Properties/packageVerificationCodeExcludedFile.md @@ -13,7 +13,7 @@ A relative filename with the root of the package archive or directory referencing a file to be excluded from the `PackageVerificationCode`. In general, every filename is preceded with a `./`, see -[RFC 3986 Uniform Resource Identifier (URI): Generic Syntax](https://www.rfc-editor.org/info/rfc3986) +[RFC 3986 Uniform Resource Identifier (URI): Generic Syntax](https://datatracker.ietf.org/doc/rfc3986) for syntax. ## Metadata diff --git a/model/Core/Vocabularies/ExternalIdentifierType.md b/model/Core/Vocabularies/ExternalIdentifierType.md index 9fd9c6bde..971ea9dd4 100644 --- a/model/Core/Vocabularies/ExternalIdentifierType.md +++ b/model/Core/Vocabularies/ExternalIdentifierType.md @@ -19,11 +19,11 @@ ExteralIdentifierType specifies the type of an external identifier. - cpe22: [Common Platform Enumeration Specification 2.2](https://cpe.mitre.org/files/cpe-specification_2.2.pdf) - cpe23: [Common Platform Enumeration: Naming Specification Version 2.3](https://csrc.nist.gov/publications/detail/nistir/7695/final) - cve: Common Vulnerabilities and Exposures identifiers, an identifier for a specific software flaw defined within the official CVE Dictionary and that conforms to the [CVE specification](https://csrc.nist.gov/glossary/term/cve_id). -- email: Email address, as defined in [RFC 3696](https://www.rfc-editor.org/info/rfc3986) Section 3. +- email: Email address, as defined in [RFC 3696](https://datatracker.ietf.org/doc/rfc3986) Section 3. - 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). - other: Used when the type does not match any of the other options. - packageUrl: Package URL, as defined in the corresponding [Annex](../../../annexes/pkg-url-specification.md) of this specification. - securityOther: Used when there is a security related identifier of unspecified type. - 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`. -- swid: Concise Software Identification (CoSWID) tag, as defined in [RFC 9393](https://www.rfc-editor.org/info/rfc9393) Section 2.3. +- swid: Concise Software Identification (CoSWID) tag, as defined in [RFC 9393](https://datatracker.ietf.org/doc/rfc9393) Section 2.3. - urlScheme: [Uniform Resource Identifier (URI) Schemes](https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml). The scheme used in order to locate a resource. diff --git a/model/Core/Vocabularies/HashAlgorithm.md b/model/Core/Vocabularies/HashAlgorithm.md index f9bbaf1c1..fe9e7d7e6 100644 --- a/model/Core/Vocabularies/HashAlgorithm.md +++ b/model/Core/Vocabularies/HashAlgorithm.md @@ -18,24 +18,24 @@ practically infeasible to invert. ## Entries -- adler32: Adler-32 checksum is part of the widely used zlib compression library as defined in [RFC 1950](https://www.rfc-editor.org/info/rfc1950) Section 2.3. -- blake2b256: BLAKE2b algorithm with a digest size of 256, as defined in [RFC 7693](https://www.rfc-editor.org/info/rfc7693) Section 4. -- blake2b384: BLAKE2b algorithm with a digest size of 384, as defined in [RFC 7693](https://www.rfc-editor.org/info/rfc7693) Section 4. -- blake2b512: BLAKE2b algorithm with a digest size of 512, as defined in [RFC 7693](https://www.rfc-editor.org/info/rfc7693) Section 4. +- adler32: Adler-32 checksum is part of the widely used zlib compression library as defined in [RFC 1950](https://datatracker.ietf.org/doc/rfc1950) Section 2.3. +- blake2b256: BLAKE2b algorithm with a digest size of 256, as defined in [RFC 7693](https://datatracker.ietf.org/doc/rfc7693) Section 4. +- blake2b384: BLAKE2b algorithm with a digest size of 384, as defined in [RFC 7693](https://datatracker.ietf.org/doc/rfc7693) Section 4. +- blake2b512: BLAKE2b algorithm with a digest size of 512, as defined in [RFC 7693](https://datatracker.ietf.org/doc/rfc7693) Section 4. - blake3: [BLAKE3](https://github.com/BLAKE3-team/BLAKE3-specs/blob/master/blake3.pdf) - crystalsDilithium: [Dilithium](https://pq-crystals.org/dilithium/) - crystalsKyber: [Kyber](https://pq-crystals.org/kyber/) - falcon: [FALCON](https://falcon-sign.info/falcon.pdf) -- md2: MD2 message-digest algorithm, as defined in [RFC 1319](https://www.rfc-editor.org/info/rfc1319/). -- md4: MD4 message-digest algorithm, as defined in [RFC 1186](https://www.rfc-editor.org/info/rfc1186). -- md5: MD5 message-digest algorithm, as defined in [RFC 1321](https://www.rfc-editor.org/info/rfc1321). +- md2: MD2 message-digest algorithm, as defined in [RFC 1319](https://datatracker.ietf.org/doc/rfc1319/). +- md4: MD4 message-digest algorithm, as defined in [RFC 1186](https://datatracker.ietf.org/doc/rfc1186). +- md5: MD5 message-digest algorithm, as defined in [RFC 1321](https://datatracker.ietf.org/doc/rfc1321). - md6: [MD6 hash function](https://people.csail.mit.edu/rivest/pubs/RABCx08.pdf) - other: any hashing algorithm that does not exist in this list of entries -- sha1: SHA-1, a secure hashing algorithm, as defined in [RFC 3174](https://www.rfc-editor.org/info/rfc3174). -- sha224: SHA-2 with a digest length of 224, as defined in [RFC 3874](https://www.rfc-editor.org/info/rfc3874). -- sha256: SHA-2 with a digest length of 256, as defined in [RFC 6234](https://www.rfc-editor.org/info/rfc6234). -- sha384: SHA-2 with a digest length of 384, as defined in [RFC 6234](https://www.rfc-editor.org/info/rfc6234). -- sha512: SHA-2 with a digest length of 512, as defined in [RFC 6234](https://www.rfc-editor.org/info/rfc6234). +- sha1: SHA-1, a secure hashing algorithm, as defined in [RFC 3174](https://datatracker.ietf.org/doc/rfc3174). +- sha224: SHA-2 with a digest length of 224, as defined in [RFC 3874](https://datatracker.ietf.org/doc/rfc3874). +- sha256: SHA-2 with a digest length of 256, as defined in [RFC 6234](https://datatracker.ietf.org/doc/rfc6234). +- sha384: SHA-2 with a digest length of 384, as defined in [RFC 6234](https://datatracker.ietf.org/doc/rfc6234). +- sha512: SHA-2 with a digest length of 512, as defined in [RFC 6234](https://datatracker.ietf.org/doc/rfc6234). - sha3_224: SHA-3 with a digest length of 224, as defined in [FIPS 202](https://csrc.nist.gov/pubs/fips/202/final). - sha3_256: SHA-3 with a digest length of 256, as defined in [FIPS 202](https://csrc.nist.gov/pubs/fips/202/final). - sha3_384: SHA-3 with a digest length of 384, as defined in [FIPS 202](https://csrc.nist.gov/pubs/fips/202/final). From b47572b6c53a932109bf0cdd036d37a86ddf9bad Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Mon, 9 Sep 2024 16:11:54 +0100 Subject: [PATCH 2/3] Remove trailing / Signed-off-by: Arthit Suriyawongkul Co-Authored-By: Gary O'Neall --- model/Core/Vocabularies/HashAlgorithm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/model/Core/Vocabularies/HashAlgorithm.md b/model/Core/Vocabularies/HashAlgorithm.md index fe9e7d7e6..3bcc294c1 100644 --- a/model/Core/Vocabularies/HashAlgorithm.md +++ b/model/Core/Vocabularies/HashAlgorithm.md @@ -26,7 +26,7 @@ practically infeasible to invert. - crystalsDilithium: [Dilithium](https://pq-crystals.org/dilithium/) - crystalsKyber: [Kyber](https://pq-crystals.org/kyber/) - falcon: [FALCON](https://falcon-sign.info/falcon.pdf) -- md2: MD2 message-digest algorithm, as defined in [RFC 1319](https://datatracker.ietf.org/doc/rfc1319/). +- md2: MD2 message-digest algorithm, as defined in [RFC 1319](https://datatracker.ietf.org/doc/rfc1319). - md4: MD4 message-digest algorithm, as defined in [RFC 1186](https://datatracker.ietf.org/doc/rfc1186). - md5: MD5 message-digest algorithm, as defined in [RFC 1321](https://datatracker.ietf.org/doc/rfc1321). - md6: [MD6 hash function](https://people.csail.mit.edu/rivest/pubs/RABCx08.pdf) From 717d6c38e687a63e12280668f0bfec953bf2fdee Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Mon, 9 Sep 2024 16:24:06 +0100 Subject: [PATCH 3/3] Add trailing / to RFC urls - same as in canonical urls Signed-off-by: Arthit Suriyawongkul --- model/Core/Datatypes/MediaType.md | 2 +- .../packageVerificationCodeExcludedFile.md | 2 +- .../Vocabularies/ExternalIdentifierType.md | 4 ++-- model/Core/Vocabularies/HashAlgorithm.md | 24 +++++++++---------- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/model/Core/Datatypes/MediaType.md b/model/Core/Datatypes/MediaType.md index 007a72346..fa8bfd1ea 100644 --- a/model/Core/Datatypes/MediaType.md +++ b/model/Core/Datatypes/MediaType.md @@ -10,7 +10,7 @@ A String constrained to the RFC 2046 specificiation. ## Description A MediaType is a string constrained to the -[RFC 2046 MIME Part Two: Media Types](https://datatracker.ietf.org/doc/rfc2046). +[RFC 2046 MIME Part Two: Media Types](https://datatracker.ietf.org/doc/rfc2046/). It provides a standardized way of indicating the type of content of an Element or a Property. diff --git a/model/Core/Properties/packageVerificationCodeExcludedFile.md b/model/Core/Properties/packageVerificationCodeExcludedFile.md index fde5c64c1..6cf73bb24 100644 --- a/model/Core/Properties/packageVerificationCodeExcludedFile.md +++ b/model/Core/Properties/packageVerificationCodeExcludedFile.md @@ -13,7 +13,7 @@ A relative filename with the root of the package archive or directory referencing a file to be excluded from the `PackageVerificationCode`. In general, every filename is preceded with a `./`, see -[RFC 3986 Uniform Resource Identifier (URI): Generic Syntax](https://datatracker.ietf.org/doc/rfc3986) +[RFC 3986 Uniform Resource Identifier (URI): Generic Syntax](https://datatracker.ietf.org/doc/rfc3986/) for syntax. ## Metadata diff --git a/model/Core/Vocabularies/ExternalIdentifierType.md b/model/Core/Vocabularies/ExternalIdentifierType.md index 971ea9dd4..e7bc8a2c9 100644 --- a/model/Core/Vocabularies/ExternalIdentifierType.md +++ b/model/Core/Vocabularies/ExternalIdentifierType.md @@ -19,11 +19,11 @@ ExteralIdentifierType specifies the type of an external identifier. - cpe22: [Common Platform Enumeration Specification 2.2](https://cpe.mitre.org/files/cpe-specification_2.2.pdf) - cpe23: [Common Platform Enumeration: Naming Specification Version 2.3](https://csrc.nist.gov/publications/detail/nistir/7695/final) - cve: Common Vulnerabilities and Exposures identifiers, an identifier for a specific software flaw defined within the official CVE Dictionary and that conforms to the [CVE specification](https://csrc.nist.gov/glossary/term/cve_id). -- email: Email address, as defined in [RFC 3696](https://datatracker.ietf.org/doc/rfc3986) Section 3. +- email: Email address, as defined in [RFC 3696](https://datatracker.ietf.org/doc/rfc3986/) Section 3. - 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). - other: Used when the type does not match any of the other options. - packageUrl: Package URL, as defined in the corresponding [Annex](../../../annexes/pkg-url-specification.md) of this specification. - securityOther: Used when there is a security related identifier of unspecified type. - 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`. -- swid: Concise Software Identification (CoSWID) tag, as defined in [RFC 9393](https://datatracker.ietf.org/doc/rfc9393) Section 2.3. +- swid: Concise Software Identification (CoSWID) tag, as defined in [RFC 9393](https://datatracker.ietf.org/doc/rfc9393/) Section 2.3. - urlScheme: [Uniform Resource Identifier (URI) Schemes](https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml). The scheme used in order to locate a resource. diff --git a/model/Core/Vocabularies/HashAlgorithm.md b/model/Core/Vocabularies/HashAlgorithm.md index 3bcc294c1..d59640a4e 100644 --- a/model/Core/Vocabularies/HashAlgorithm.md +++ b/model/Core/Vocabularies/HashAlgorithm.md @@ -18,24 +18,24 @@ practically infeasible to invert. ## Entries -- adler32: Adler-32 checksum is part of the widely used zlib compression library as defined in [RFC 1950](https://datatracker.ietf.org/doc/rfc1950) Section 2.3. -- blake2b256: BLAKE2b algorithm with a digest size of 256, as defined in [RFC 7693](https://datatracker.ietf.org/doc/rfc7693) Section 4. -- blake2b384: BLAKE2b algorithm with a digest size of 384, as defined in [RFC 7693](https://datatracker.ietf.org/doc/rfc7693) Section 4. -- blake2b512: BLAKE2b algorithm with a digest size of 512, as defined in [RFC 7693](https://datatracker.ietf.org/doc/rfc7693) Section 4. +- adler32: Adler-32 checksum is part of the widely used zlib compression library as defined in [RFC 1950](https://datatracker.ietf.org/doc/rfc1950/) Section 2.3. +- blake2b256: BLAKE2b algorithm with a digest size of 256, as defined in [RFC 7693](https://datatracker.ietf.org/doc/rfc7693/) Section 4. +- blake2b384: BLAKE2b algorithm with a digest size of 384, as defined in [RFC 7693](https://datatracker.ietf.org/doc/rfc7693/) Section 4. +- blake2b512: BLAKE2b algorithm with a digest size of 512, as defined in [RFC 7693](https://datatracker.ietf.org/doc/rfc7693/) Section 4. - blake3: [BLAKE3](https://github.com/BLAKE3-team/BLAKE3-specs/blob/master/blake3.pdf) - crystalsDilithium: [Dilithium](https://pq-crystals.org/dilithium/) - crystalsKyber: [Kyber](https://pq-crystals.org/kyber/) - falcon: [FALCON](https://falcon-sign.info/falcon.pdf) -- md2: MD2 message-digest algorithm, as defined in [RFC 1319](https://datatracker.ietf.org/doc/rfc1319). -- md4: MD4 message-digest algorithm, as defined in [RFC 1186](https://datatracker.ietf.org/doc/rfc1186). -- md5: MD5 message-digest algorithm, as defined in [RFC 1321](https://datatracker.ietf.org/doc/rfc1321). +- md2: MD2 message-digest algorithm, as defined in [RFC 1319](https://datatracker.ietf.org/doc/rfc1319/). +- md4: MD4 message-digest algorithm, as defined in [RFC 1186](https://datatracker.ietf.org/doc/rfc1186/). +- md5: MD5 message-digest algorithm, as defined in [RFC 1321](https://datatracker.ietf.org/doc/rfc1321/). - md6: [MD6 hash function](https://people.csail.mit.edu/rivest/pubs/RABCx08.pdf) - other: any hashing algorithm that does not exist in this list of entries -- sha1: SHA-1, a secure hashing algorithm, as defined in [RFC 3174](https://datatracker.ietf.org/doc/rfc3174). -- sha224: SHA-2 with a digest length of 224, as defined in [RFC 3874](https://datatracker.ietf.org/doc/rfc3874). -- sha256: SHA-2 with a digest length of 256, as defined in [RFC 6234](https://datatracker.ietf.org/doc/rfc6234). -- sha384: SHA-2 with a digest length of 384, as defined in [RFC 6234](https://datatracker.ietf.org/doc/rfc6234). -- sha512: SHA-2 with a digest length of 512, as defined in [RFC 6234](https://datatracker.ietf.org/doc/rfc6234). +- sha1: SHA-1, a secure hashing algorithm, as defined in [RFC 3174](https://datatracker.ietf.org/doc/rfc3174/). +- sha224: SHA-2 with a digest length of 224, as defined in [RFC 3874](https://datatracker.ietf.org/doc/rfc3874/). +- sha256: SHA-2 with a digest length of 256, as defined in [RFC 6234](https://datatracker.ietf.org/doc/rfc6234/). +- sha384: SHA-2 with a digest length of 384, as defined in [RFC 6234](https://datatracker.ietf.org/doc/rfc6234/). +- sha512: SHA-2 with a digest length of 512, as defined in [RFC 6234](https://datatracker.ietf.org/doc/rfc6234/). - sha3_224: SHA-3 with a digest length of 224, as defined in [FIPS 202](https://csrc.nist.gov/pubs/fips/202/final). - sha3_256: SHA-3 with a digest length of 256, as defined in [FIPS 202](https://csrc.nist.gov/pubs/fips/202/final). - sha3_384: SHA-3 with a digest length of 384, as defined in [FIPS 202](https://csrc.nist.gov/pubs/fips/202/final).