#484: Update docs for Revocation Point DataURL uniqueness (#500)

* Update docs for Revocation Point DataURL uniqueness * Update links
zigbee-alliance · Aug 7, 2023 · c1081db · c1081db
1 parent 51151a0
commit c1081db
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/bench/README.md b/bench/README.md
@@ -368,8 +368,8 @@ More details can be found in:
 
 - [locust.conf](../locust.conf): default values
 - `locust --help` (being in the project root)
-- [locust configuration](https://docs.locust.io/en/stable/configuration.html)
-- [locust stats](https://docs.locust.io/en/stable/retrieving-stats.html)
+- [locust configuration](https://docs.locust.io/en/latest/configuration.html)
+- [locust stats](https://docs.locust.io/en/latest/retrieving-stats.html)
 
 ### Re-run
 

diff --git a/docs/design/benchmarking.md b/docs/design/benchmarking.md
@@ -121,7 +121,7 @@ As long as DCledger based on Cosmos SDK and Tendermint which provide standard HT
 - tests can be configured using simple python scripts (version control, CI/CD), in comparison:
   - JS based configuration for [K6](https://k6.io/) will likely require more efforts
   - [jMeter](https://jmeter.apache.org/) configuration is mostly about UI but not coding
-- [distributed testing](http://docs.locust.io/en/stable/running-distributed.html) with results aggregation is supported (if we decide to use it)
+- [distributed testing](http://docs.locust.io/en/latest/running-distributed.html) with results aggregation is supported (if we decide to use it)
 - there are some [concerns](https://k6.io/blog/comparing-best-open-source-load-testing-tools/) regarding its performance and accuracy but the current vision is that it should be acceptable for our case
 
 ## Testing Environment Provisioning Automation

diff --git a/docs/design/da-pki-revocation-design.md b/docs/design/da-pki-revocation-design.md
@@ -67,7 +67,7 @@ and DACs (leaf certificates) added to DCL if they are revoked in the CRL identif
     - label: `string` -  A label to disambiguate multiple revocation information partitions of a particular issuer.
     - crlSignerCertificate: `string` - The issuer certificate whose revocation information is provided in the distribution point entry, encoded in X.509v3 PEM format. The corresponding CLI parameter can contain either a PEM string or a path to a file containing the data.
     - issuerSubjectKeyID: `string` - Uniquely identifies the PAA or PAI for which this revocation distribution point is provided. Must consist of even number of uppercase hexadecimal characters ([0-9A-F]), with no whitespace and no non-hexadecimal characters., e.g: `5A880E6C3653D07FB08971A3F473790930E62BDB`.
-    - dataUrl: `string` -  The URL where to obtain the information in the format indicated by the RevocationType field. Must start with either `http` or `https`.
+    - dataUrl: `string` -  The URL where to obtain the information in the format indicated by the RevocationType field. Must start with either `http` or `https`. Must be unique for all pairs of VendorID and IssuerSubjectKeyID.
     - dataFileSize: `optional(uint64)` -  Total size in bytes of the file found at the DataUrl. Must be omitted if RevocationType is 1.
     - dataDigest: `optional(string)` -  Digest of the entire contents of the associated file downloaded from the DataUrl. Must be omitted if RevocationType is 1. Must be provided if and only if the `DataFileSize` field is present.
     - dataDigestType: `optional(uint32)` - The type of digest used in the DataDigest field from the list of [1, 7, 8, 10, 11, 12] (IANA Named Information Hash Algorithm Registry). Must be provided if and only if the `DataDigest` field is present.
@@ -92,7 +92,7 @@ Updates an existing PKI Revocation distribution endpoint owned by the sender.
     - label: `string` -  A label to disambiguate multiple revocation information partitions of a particular issuer.
     - issuerSubjectKeyID: `string` - Uniquely identifies the PAA or PAI for which this revocation distribution point is provided. Must consist of even number of uppercase hexadecimal characters ([0-9A-F]), with no whitespace and no non-hexadecimal characters., e.g: `5A880E6C3653D07FB08971A3F473790930E62BDB`.
     - crlSignerCertificate: `optional(string)` - The issuer certificate whose revocation information is provided in the distribution point entry, encoded in X.509v3 PEM format. The corresponding CLI parameter can contain either a PEM string or a path to a file containing the data.
-    - dataUrl: `optional(string)` -  The URL where to obtain the information in the format indicated by the RevocationType field. Must start with either `http` or `https`.
+    - dataUrl: `optional(string)` -  The URL where to obtain the information in the format indicated by the RevocationType field. Must start with either `http` or `https`. Must be unique for all pairs of VendorID and IssuerSubjectKeyID.
     - dataFileSize: `optional(uint64)` -  Total size in bytes of the file found at the DataUrl. Must be omitted if RevocationType is 1.
     - dataDigest: `optional(string)` -  Digest of the entire contents of the associated file downloaded from the DataUrl. Must be omitted if RevocationType is 1. Must be provided if and only if the `DataFileSize` field is present.
     - dataDigestType: `optional(uint32)` - The type of digest used in the DataDigest field from the list of [1, 7, 8, 10, 11, 12] (IANA Named Information Hash Algorithm Registry). Must be provided if and only if the `DataDigest` field is present.
@@ -202,7 +202,7 @@ Gets a list of all revocation distribution points.
        - Query for a PAA where `Subject == CRLSignerCertificate.Issuer` and `SubjectKeyID == CRLSignerCertificate.AuthorityKeyId`
        - Build certification path with both elements, verify path
 - Check that (VendorID, IssuerSubjectKeyID, Label) combination is unique when adding the distribution endpoint.
-- Check that (VendorID, IssuerSubjectKeyID, DataUrl) combination is unique when adding the
+- Check that (VendorID, IssuerSubjectKeyID, DataUrl) combination is unique when adding the distribution endpoint.
 
 #### UPDATE_PKI_REVOCATION_DISTRIBUTION_POINT
 

diff --git a/docs/transactions.md b/docs/transactions.md
@@ -1027,7 +1027,7 @@ and DACs (leaf certificates) added to DCL if they are revoked in the CRL identif
   - label: `string` -  A label to disambiguate multiple revocation information partitions of a particular issuer.
   - crlSignerCertificate: `string` - The issuer certificate whose revocation information is provided in the distribution point entry, encoded in X.509v3 PEM format. The corresponding CLI parameter can contain either a PEM string or a path to a file containing the data.
   - issuerSubjectKeyID: `string` - Uniquely identifies the PAA or PAI for which this revocation distribution point is provided. Must consist of even number of uppercase hexadecimal characters ([0-9A-F]), with no whitespace and no non-hexadecimal characters., e.g: `5A880E6C3653D07FB08971A3F473790930E62BDB`.
-  - dataUrl: `string` -  The URL where to obtain the information in the format indicated by the RevocationType field. Must start with either `http` or `https`.
+  - dataUrl: `string` -  The URL where to obtain the information in the format indicated by the RevocationType field. Must start with either `http` or `https`. Must be unique for all pairs of VendorID and IssuerSubjectKeyID.
   - dataFileSize: `optional(uint64)` -  Total size in bytes of the file found at the DataUrl. Must be omitted if RevocationType is 1.
   - dataDigest: `optional(string)` -  Digest of the entire contents of the associated file downloaded from the DataUrl. Must be omitted if RevocationType is 1. Must be provided if and only if the `DataFileSize` field is present.
   - dataDigestType: `optional(uint32)` - The type of digest used in the DataDigest field from the list of [1, 7, 8, 10, 11, 12] (IANA Named Information Hash Algorithm Registry). Must be provided if and only if the `DataDigest` field is present.
@@ -1069,7 +1069,7 @@ Updates an existing PKI Revocation distribution endpoint (such as RFC5280 Certif
   - label: `string` -  A label to disambiguate multiple revocation information partitions of a particular issuer.
   - issuerSubjectKeyID: `string` - Uniquely identifies the PAA or PAI for which this revocation distribution point is provided. Must consist of even number of uppercase hexadecimal characters ([0-9A-F]), with no whitespace and no non-hexadecimal characters., e.g: `5A880E6C3653D07FB08971A3F473790930E62BDB`.
   - crlSignerCertificate: `optional(string)` - The issuer certificate whose revocation information is provided in the distribution point entry, encoded in X.509v3 PEM format. The corresponding CLI parameter can contain either a PEM string or a path to a file containing the data.
-  - dataUrl: `optional(string)` -  The URL where to obtain the information in the format indicated by the RevocationType field. Must start with either `http` or `https`.
+  - dataUrl: `optional(string)` -  The URL where to obtain the information in the format indicated by the RevocationType field. Must start with either `http` or `https`. Must be unique for all pairs of VendorID and IssuerSubjectKeyID.
   - dataFileSize: `optional(uint64)` -  Total size in bytes of the file found at the DataUrl. Must be omitted if RevocationType is 1.
   - dataDigest: `optional(string)` -  Digest of the entire contents of the associated file downloaded from the DataUrl. Must be omitted if RevocationType is 1. Must be provided if and only if the `DataFileSize` field is present.
   - dataDigestType: `optional(uint32)` - The type of digest used in the DataDigest field from the list of [1, 7, 8, 10, 11, 12] (IANA Named Information Hash Algorithm Registry). Must be provided if and only if the `DataDigest` field is present.